Package org.apache.solr.handler.component

Class ActiveTasksListHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.component.TaskManagementHandler

org.apache.solr.handler.component.ActiveTasksListHandler

All Implemented Interfaces:

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

public class ActiveTasksListHandler
extends TaskManagementHandler

Handles request for listing all active cancellable tasks

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

aggregateNodeLevelMetricsEnabled, 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
ActiveTasksListHandler()

Method Summary

Modifier and Type	Method	Description
Collection<Api>	getApis()	It is possible to support multiple v2 apis by a single requesthandler
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
PermissionNameProvider.Name	getPermissionName(AuthorizationContext ctx)
SolrRequestHandler	getSubHandler(String path)	Return a RequestHandler to handle a subpath from the path this handler is registered.
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
Boolean	registerV2()	Whether this request handler must be made available at the /v2/ path

Methods inherited from class org.apache.solr.handler.component.TaskManagementHandler

buildComponentsList, buildResponseBuilder, inform, processRequest

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

getInitArgs, getMetricsForThisRequest, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, handleRequest, 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

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

close

Constructor Detail

ActiveTasksListHandler

public ActiveTasksListHandler()

Method Detail

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

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx)

getSubHandler

public SolrRequestHandler getSubHandler(String path)

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

It is possible to support multiple v2 apis by a single requesthandler

Specified by:

getApis in interface ApiSupport

Overrides:

getApis in class RequestHandlerBase

Returns:

the list of v2 api implementations