Package org.apache.solr.handler.admin
Class MetricsHandler
- java.lang.Object
-
- org.apache.solr.handler.RequestHandlerBase
-
- org.apache.solr.handler.admin.MetricsHandler
-
- All Implemented Interfaces:
AutoCloseable
,ApiSupport
,SolrInfoBean
,NestedRequestHandler
,SolrMetricProducer
,SolrRequestHandler
,PermissionNameProvider
public class MetricsHandler extends RequestHandlerBase implements PermissionNameProvider
Request handler to return metrics
-
-
Nested Class Summary
-
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
ALL
static String
COMPACT_PARAM
static String
GROUP_PARAM
static String
KEY_PARAM
static String
PREFIX_PARAM
static String
PROPERTY_PARAM
static String
REGEX_PARAM
static String
REGISTRY_PARAM
static String
TYPE_PARAM
-
Fields inherited from class org.apache.solr.handler.RequestHandlerBase
appends, defaults, httpCaching, initArgs, invariants, 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 MetricsHandler()
MetricsHandler(CoreContainer coreContainer)
MetricsHandler(SolrMetricManager metricManager)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SolrInfoBean.Category
getCategory()
Category of this componentString
getDescription()
Simple one or two line descriptionPermissionNameProvider.Name
getPermissionName(AuthorizationContext request)
void
handleKeyRequest(String[] keys, BiConsumer<String,Object> consumer)
void
handleRequest(SolrParams params, BiConsumer<String,Object> consumer)
void
handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
Set<String>
parseRegistries(String[] groupStr, String[] registryStr)
-
Methods inherited from class org.apache.solr.handler.RequestHandlerBase
getApis, getInitArgs, getMetricNames, getName, getPluginInfo, getRequestHandler, getSolrMetricsContext, getSolrParamsFromNamedList, getSubHandler, 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, registerV2
-
Methods inherited from interface org.apache.solr.core.SolrInfoBean
getMetricRegistry, getMetricsSnapshot, registerMetricName
-
Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer
close, initializeMetrics
-
-
-
-
Field Detail
-
COMPACT_PARAM
public static final String COMPACT_PARAM
- See Also:
- Constant Field Values
-
PREFIX_PARAM
public static final String PREFIX_PARAM
- See Also:
- Constant Field Values
-
REGEX_PARAM
public static final String REGEX_PARAM
- See Also:
- Constant Field Values
-
PROPERTY_PARAM
public static final String PROPERTY_PARAM
- See Also:
- Constant Field Values
-
REGISTRY_PARAM
public static final String REGISTRY_PARAM
- See Also:
- Constant Field Values
-
GROUP_PARAM
public static final String GROUP_PARAM
- See Also:
- Constant Field Values
-
KEY_PARAM
public static final String KEY_PARAM
- See Also:
- Constant Field Values
-
TYPE_PARAM
public static final String TYPE_PARAM
- See Also:
- Constant Field Values
-
ALL
public static final String ALL
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MetricsHandler
public MetricsHandler()
-
MetricsHandler
public MetricsHandler(CoreContainer coreContainer)
-
MetricsHandler
public MetricsHandler(SolrMetricManager metricManager)
-
-
Method Detail
-
getPermissionName
public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)
- Specified by:
getPermissionName
in interfacePermissionNameProvider
-
handleRequestBody
public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception
- Specified by:
handleRequestBody
in classRequestHandlerBase
- Throws:
Exception
-
handleRequest
public void handleRequest(SolrParams params, BiConsumer<String,Object> consumer) throws Exception
- Throws:
Exception
-
handleKeyRequest
public void handleKeyRequest(String[] keys, BiConsumer<String,Object> consumer) throws Exception
- Throws:
Exception
-
getDescription
public String getDescription()
Description copied from interface:SolrInfoBean
Simple one or two line description- Specified by:
getDescription
in interfaceSolrInfoBean
- Specified by:
getDescription
in classRequestHandlerBase
-
getCategory
public SolrInfoBean.Category getCategory()
Description copied from interface:SolrInfoBean
Category of this component- Specified by:
getCategory
in interfaceSolrInfoBean
- Overrides:
getCategory
in classRequestHandlerBase
-
-