Package org.apache.solr.handler.component

Class TaskManagementHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.component.TaskManagementHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

ActiveTasksListHandler, QueryCancellationHandler

public abstract class TaskManagementHandler
extends RequestHandlerBase
implements SolrCoreAware, PermissionNameProvider

Abstract class which serves as the root of all task managing handlers

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 inherited from class org.apache.solr.handler.RequestHandlerBase

appends, defaults, httpCaching, initArgs, invariants, metrics, solrMetricsContext

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

ANY, NULL, values

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

TYPE

Constructor Summary

Constructors

Constructor	Description
TaskManagementHandler()

Method Summary

Modifier and Type	Method	Description
static List<SearchComponent>	buildComponentsList()
static ResponseBuilder	buildResponseBuilder(SolrQueryRequest req, SolrQueryResponse rsp, List<SearchComponent> components)
void	inform(SolrCore core)
protected void	processRequest(SolrQueryRequest req, ResponseBuilder rb, Map<String,String> extraParams)	Process the actual request.

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

getApis, getCategory, getDescription, getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, handleRequest, handleRequestBody, init, initializeMetrics, 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, registerV2

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

getPermissionName

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

close

Constructor Detail

TaskManagementHandler

public TaskManagementHandler()

Method Detail

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

processRequest

protected void processRequest(SolrQueryRequest req,
                              ResponseBuilder rb,
                              Map<String,String> extraParams)
                       throws IOException

Process the actual request. extraParams is required for allowing sub handlers to pass in custom parameters to be put in the outgoing shard request

Throws:

IOException

buildComponentsList

public static List<SearchComponent> buildComponentsList()

buildResponseBuilder

public static ResponseBuilder buildResponseBuilder(SolrQueryRequest req,
                                                   SolrQueryResponse rsp,
                                                   List<SearchComponent> components)