Package org.apache.solr.handler.admin

Class SystemInfoHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.SystemInfoHandler

All Implemented Interfaces:

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

public class SystemInfoHandler
extends RequestHandlerBase

This handler returns system info

Since:

solr 1.2

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	REDACT_STRING

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
SystemInfoHandler()
SystemInfoHandler(CoreContainer cc)

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
static SimpleOrderedMap<Object>	getJvmInfo()	Get JVM Info - including memory info
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
SimpleOrderedMap<Object>	getSecurityInfo(SolrQueryRequest req)	Get Security Info
static SimpleOrderedMap<Object>	getSystemInfo()	Get system info
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

getInitArgs, getMetricsForThisRequest, 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

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

close

Field Detail

REDACT_STRING

public static String REDACT_STRING

Constructor Detail

SystemInfoHandler

public SystemInfoHandler()

SystemInfoHandler

public SystemInfoHandler(CoreContainer cc)

Method Detail

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

getSystemInfo

public static SimpleOrderedMap<Object> getSystemInfo()

Get system info

getJvmInfo

public static SimpleOrderedMap<Object> getJvmInfo()

Get JVM Info - including memory info

getSecurityInfo

public SimpleOrderedMap<Object> getSecurityInfo(SolrQueryRequest req)

Get Security Info

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

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

registerV2

public Boolean registerV2()

Description copied from interface: ApiSupport

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

getPermissionName

public PermissionNameProvider.Name getPermissionName(AuthorizationContext request)