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

aggregateNodeLevelMetricsEnabled, appends, defaults, httpCaching, initArgs, invariants, metrics, publishCpuTime, REQUEST_CPU_TIMER_CONTEXT, solrMetricsContext, SOURCE_ATTR

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

ANY, NULL, values

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

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

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
static <T extends PlatformManagedObject> void	forEachGetterValue(T obj, Class<? extends T> intf, BiConsumer<String,Object> consumer)	Iterates over properties of the given MXBean and invokes the provided consumer with each property name and its current value.
static <T extends PlatformManagedObject> void	forEachGetterValue(T obj, String[] interfaces, BiConsumer<String,Object> consumer)	Iterates over properties of the given MXBean and invokes the provided consumer with each property name and its current value.
Collection<Api>	getApis()	Returns any (non-JAX-RS annotated) APIs associated with this request handler.
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
static org.apache.solr.common.util.SimpleOrderedMap<Object>	getJvmInfo(NodeConfig nodeConfig)	Get JVM Info - including memory info
PermissionNameProvider.Name	getPermissionName(AuthorizationContext request)
org.apache.solr.common.util.SimpleOrderedMap<Object>	getSecurityInfo(SolrQueryRequest req)	Get Security Info
static org.apache.solr.common.util.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, 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

getJerseyResources, registerV1

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

close

Constructor Details

SystemInfoHandler

public SystemInfoHandler()

SystemInfoHandler

public SystemInfoHandler(CoreContainer cc)

Method Details

forEachGetterValue

public static <T extends PlatformManagedObject>
void forEachGetterValue(T obj,
 String[] interfaces,
 BiConsumer<String,Object> consumer)

Iterates over properties of the given MXBean and invokes the provided consumer with each property name and its current value.

Type Parameters:

T - formal type

Parameters:

obj - an instance of MXBean

interfaces - interfaces that it may implement. Each interface will be tried in turn, and only if it exists and if it contains unique properties then they will be added as metrics.

consumer - consumer for each property name and value

forEachGetterValue

public static <T extends PlatformManagedObject>
void forEachGetterValue(T obj,
 Class<? extends T> intf,
 BiConsumer<String,Object> consumer)

Iterates over properties of the given MXBean and invokes the provided consumer with each property name and its current value.

Type Parameters:

T - formal type

Parameters:

obj - an instance of MXBean

intf - MXBean interface, one of PlatformManagedObject-s

consumer - consumer for each property name and value

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

Exception

getSystemInfo

public static org.apache.solr.common.util.SimpleOrderedMap<Object> getSystemInfo()

Get system info

getJvmInfo

public static org.apache.solr.common.util.SimpleOrderedMap<Object> getJvmInfo(NodeConfig nodeConfig)

Get JVM Info - including memory info

getSecurityInfo

public org.apache.solr.common.util.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

Returns any (non-JAX-RS annotated) APIs associated with this request handler.

Specified by:

getApis in interface ApiSupport

Overrides:

getApis in class RequestHandlerBase

See Also:

• ApiSupport.getJerseyResources()

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)