org.apache.solr.handler.admin

Class SystemInfoHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.SystemInfoHandler

All Implemented Interfaces:

SolrInfoMBean, SolrRequestHandler

public class SystemInfoHandler
extends RequestHandlerBase

This handler returns system info NOTE: the response format is still likely to change. It should be designed so that it works nicely with an XSLT transformation. Until we have a nice XSLT front end for /admin, the format is still open to change.

Since:

solr 1.2

Version:

$Id: SystemInfoHandler.java 1297430 2012-03-06 11:20:53Z siren $

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean

SolrInfoMBean.Category

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	log
private static long	ONE_GB
private static long	ONE_KB
private static long	ONE_MB

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

appends, defaults, httpCaching, initArgs, invariants

Constructor Summary

Constructors

Constructor and Description
SystemInfoHandler()

Method Summary

Modifier and Type	Method and Description
(package private) static void	addGetterIfAvaliable(java.lang.Object obj, java.lang.String getter, NamedList<java.lang.Object> info) Try to run a getter function.
private static java.lang.String	execute(java.lang.String cmd) Utility function to execute a function
private static SimpleOrderedMap<java.lang.Object>	getCoreInfo(SolrCore core) Get system info
java.lang.String	getDescription() Simple one or two line description
static SimpleOrderedMap<java.lang.Object>	getJvmInfo() Get JVM Info - including memory info
private static SimpleOrderedMap<java.lang.Object>	getLuceneInfo()
java.lang.String	getSource() CVS Source, SVN Source, etc
java.lang.String	getSourceId() CVS Id, SVN Id, etc
static SimpleOrderedMap<java.lang.Object>	getSystemInfo() Get system info
java.lang.String	getVersion() Simple common usage version, e.g.
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
private static java.lang.String	humanReadableUnits(long bytes, java.text.DecimalFormat df) Return good default units based on byte size.

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

getCategory, getDocs, getInitArgs, getName, getStatistics, handleRequest, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

private static org.slf4j.Logger log

ONE_KB

private static final long ONE_KB

See Also:

Constant Field Values

ONE_MB

private static final long ONE_MB

See Also:

Constant Field Values

ONE_GB

private static final long ONE_GB

See Also:

Constant Field Values

Constructor Detail

SystemInfoHandler

public SystemInfoHandler()

Method Detail

handleRequestBody

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

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

java.lang.Exception

getCoreInfo

private static SimpleOrderedMap<java.lang.Object> getCoreInfo(SolrCore core)
                                                       throws java.lang.Exception

Get system info

Throws:

java.lang.Exception

getSystemInfo

public static SimpleOrderedMap<java.lang.Object> getSystemInfo()
                                                        throws java.lang.Exception

Get system info

Throws:

java.lang.Exception

addGetterIfAvaliable

static void addGetterIfAvaliable(java.lang.Object obj,
                                 java.lang.String getter,
                                 NamedList<java.lang.Object> info)

Try to run a getter function. This is useful because java 1.6 has a few extra useful functions on the OperatingSystemMXBean If you are running a sun jvm, there are nice functions in: UnixOperatingSystemMXBean and com.sun.management.OperatingSystemMXBean it is package protected so it can be tested...

execute

private static java.lang.String execute(java.lang.String cmd)

Utility function to execute a function

getJvmInfo

public static SimpleOrderedMap<java.lang.Object> getJvmInfo()

Get JVM Info - including memory info

getLuceneInfo

private static SimpleOrderedMap<java.lang.Object> getLuceneInfo()
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

public java.lang.String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

Specified by:

getDescription in class RequestHandlerBase

getVersion

public java.lang.String getVersion()

Description copied from interface: SolrInfoMBean

Simple common usage version, e.g. 2.0

Specified by:

getVersion in interface SolrInfoMBean

Specified by:

getVersion in class RequestHandlerBase

getSourceId

public java.lang.String getSourceId()

Description copied from interface: SolrInfoMBean

CVS Id, SVN Id, etc

Specified by:

getSourceId in interface SolrInfoMBean

Specified by:

getSourceId in class RequestHandlerBase

getSource

public java.lang.String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

Specified by:

getSource in class RequestHandlerBase

humanReadableUnits

private static java.lang.String humanReadableUnits(long bytes,
                                                   java.text.DecimalFormat df)

Return good default units based on byte size.