Package org.apache.solr.handler.admin

Class SegmentsInfoRequestHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.SegmentsInfoRequestHandler

All Implemented Interfaces:

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

public class SegmentsInfoRequestHandler
extends RequestHandlerBase

This handler exposes information about last commit generation segments

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
static String	CORE_INFO_PARAM
static String	FIELD_INFO_PARAM
static String	RAW_SIZE_DETAILS_PARAM
static String	RAW_SIZE_PARAM
static String	RAW_SIZE_SAMPLING_PERCENT_PARAM
static String	RAW_SIZE_SUMMARY_PARAM
static String	SIZE_INFO_PARAM

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
SegmentsInfoRequestHandler()

Method Summary

Modifier and Type	Method	Description
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
Collection<Class<? extends JerseyResource>>	getJerseyResources()	Returns any JAX-RS annotated v2 APIs associated with this request handler.
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
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.RequestHandlerBase

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

FIELD_INFO_PARAM

public static final String FIELD_INFO_PARAM

See Also:

Constant Field Values

CORE_INFO_PARAM

public static final String CORE_INFO_PARAM

See Also:

Constant Field Values

SIZE_INFO_PARAM

public static final String SIZE_INFO_PARAM

See Also:

Constant Field Values

RAW_SIZE_PARAM

public static final String RAW_SIZE_PARAM

See Also:

Constant Field Values

RAW_SIZE_SUMMARY_PARAM

public static final String RAW_SIZE_SUMMARY_PARAM

See Also:

Constant Field Values

RAW_SIZE_DETAILS_PARAM

public static final String RAW_SIZE_DETAILS_PARAM

See Also:

Constant Field Values

RAW_SIZE_SAMPLING_PERCENT_PARAM

public static final String RAW_SIZE_SAMPLING_PERCENT_PARAM

See Also:

Constant Field Values

Constructor Detail

SegmentsInfoRequestHandler

public SegmentsInfoRequestHandler()

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 request)

registerV2

public Boolean registerV2()

Description copied from interface: ApiSupport

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

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()