Package org.apache.solr.handler.admin

Class InfoHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.InfoHandler

All Implemented Interfaces:

AutoCloseable, ApiSupport, SolrInfoBean, NestedRequestHandler, SolrMetricProducer, SolrRequestHandler, PermissionNameProvider

public class InfoHandler
extends RequestHandlerBase

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.handler.RequestHandlerBase

RequestHandlerBase.HandlerMetrics

Nested classes/interfaces inherited from interface org.apache.solr.security.PermissionNameProvider

PermissionNameProvider.Name

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
protected final CoreContainer	coreContainer

Fields inherited from class org.apache.solr.handler.RequestHandlerBase

aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, publishCpuTime, REQUEST_CPU_TIMER_CONTEXT, solrMetricsContext, SOURCE_ATTR

Fields inherited from interface org.apache.solr.security.PermissionNameProvider

ANY, NULL, values

Fields inherited from interface org.apache.solr.metrics.SolrMetricProducer

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

Fields inherited from interface org.apache.solr.request.SolrRequestHandler

TYPE

Constructor Summary

Constructors

Constructor	Description
InfoHandler(CoreContainer coreContainer)	Overloaded ctor to inject CoreContainer into the handler.

Method Summary

Modifier and Type	Method	Description
Collection<Api>	getApis()	Returns any (non-JAX-RS annotated) APIs associated with this request handler.
SolrInfoBean.Category	getCategory()	Category of this component
CoreContainer	getCoreContainer()	The instance of CoreContainer this handler handles.
String	getDescription()	Simple one or two line description
HealthCheckHandler	getHealthCheckHandler()
Collection<Class<? extends JerseyResource>>	getJerseyResources()	Returns any JAX-RS annotated v2 APIs associated with this request handler.
LoggingHandler	getLoggingHandler()
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
PropertiesRequestHandler	getPropertiesHandler()
SolrRequestHandler	getSubHandler(String subPath)	Return a RequestHandler to handle a subpath from the path this handler is registered.
SystemInfoHandler	getSystemInfoHandler()
ThreadDumpHandler	getThreadDumpHandler()
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
final void	init(org.apache.solr.common.util.NamedList<?> args)	Initializes the SolrRequestHandler by creating three SolrParams named.
Boolean	registerV2()	Whether this request handler must be made available at the /v2/ path
protected void	setHealthCheckHandler(HealthCheckHandler healthCheckHandler)
protected void	setLoggingHandler(LoggingHandler loggingHandler)
protected void	setPropertiesHandler(PropertiesRequestHandler propertiesHandler)
protected void	setSystemInfoHandler(SystemInfoHandler systemInfoHandler)
protected void	setThreadDumpHandler(ThreadDumpHandler threadDumpHandler)

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, handleRequest, initializeMetrics, isInternalShardRequest, processErrorMetricsOnException, processReceivedException, setPluginInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.api.ApiSupport

registerV1

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close

Field Details

coreContainer

protected final CoreContainer coreContainer

Constructor Details

InfoHandler

public InfoHandler(CoreContainer coreContainer)

Overloaded ctor to inject CoreContainer into the handler.

Parameters:

coreContainer - Core Container of the solr webapp installed.

Method Details

init

public final void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from class: RequestHandlerBase

Initializes the SolrRequestHandler by creating three SolrParams named.

table of parameters

Name	Description
defaults	Contains all of the named arguments contained within the list element named "defaults".
appends	Contains all of the named arguments contained within the list element named "appends".
invariants	Contains all of the named arguments contained within the list element named "invariants".

Example:

 <lst name="defaults">
 <str name="echoParams">explicit</str>
 <str name="qf">text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0</str>
 <str name="mm">2<-1 5<-2 6<90%</str>
 <str name="bq">incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2</str>
 </lst>
 <lst name="appends">
 <str name="fq">inStock:true</str>
 </lst>

 <lst name="invariants">
 <str name="facet.field">cat</str>
 <str name="facet.field">manu_exact</str>
 <str name="facet.query">price:[* TO 500]</str>
 <str name="facet.query">price:[500 TO *]</str>
 </lst>
 

Specified by:

init in interface SolrRequestHandler

Overrides:

init in class RequestHandlerBase

Parameters:

args - The NamedList to initialize from

See Also:

• RequestHandlerBase.handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)
• RequestHandlerBase.handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)
• SolrPluginUtils.setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams)

• See also the example solrconfig.xml located in the Solr codebase (example/solr/conf).

getCoreContainer

public CoreContainer getCoreContainer()

The instance of CoreContainer this handler handles. This should be the CoreContainer instance that created this handler.

Returns:

a CoreContainer instance

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
 SolrQueryResponse rsp)
                       throws Exception

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class RequestHandlerBase

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class RequestHandlerBase

getPropertiesHandler

public PropertiesRequestHandler getPropertiesHandler()

getThreadDumpHandler

public ThreadDumpHandler getThreadDumpHandler()

getLoggingHandler

public LoggingHandler getLoggingHandler()

getSystemInfoHandler

public SystemInfoHandler getSystemInfoHandler()

getHealthCheckHandler

public HealthCheckHandler getHealthCheckHandler()

setPropertiesHandler

protected void setPropertiesHandler(PropertiesRequestHandler propertiesHandler)

setThreadDumpHandler

protected void setThreadDumpHandler(ThreadDumpHandler threadDumpHandler)

setLoggingHandler

protected void setLoggingHandler(LoggingHandler loggingHandler)

setSystemInfoHandler

protected void setSystemInfoHandler(SystemInfoHandler systemInfoHandler)

setHealthCheckHandler

protected void setHealthCheckHandler(HealthCheckHandler healthCheckHandler)

getSubHandler

public SolrRequestHandler getSubHandler(String subPath)

Description copied from interface: NestedRequestHandler

Return a RequestHandler to handle a subpath from the path this handler is registered.

Specified by:

getSubHandler in interface NestedRequestHandler

Overrides:

getSubHandler in class RequestHandlerBase

registerV2

public Boolean registerV2()

Description copied from interface: ApiSupport

Whether this request handler must be made available at the /v2/ path

getApis

public Collection<Api> getApis()

Description copied from interface: ApiSupport

Returns any (non-JAX-RS annotated) APIs associated with this request handler.

Specified by:

getApis in interface ApiSupport

Overrides:

getApis in class RequestHandlerBase

See Also:

• ApiSupport.getJerseyResources()

getJerseyResources

public Collection<Class<? extends JerseyResource>> getJerseyResources()

Description copied from interface: ApiSupport

Returns any JAX-RS annotated v2 APIs associated with this request handler.

See Also:

• ApiSupport.getApis()

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)