org.apache.solr.search

Class SolrFieldCacheMBean

java.lang.Object

org.apache.solr.search.SolrFieldCacheMBean

All Implemented Interfaces:

JmxMonitoredMap.JmxAugmentedSolrInfoMBean, SolrInfoMBean, SolrMetricProducer

public class SolrFieldCacheMBean
extends Object
implements JmxMonitoredMap.JmxAugmentedSolrInfoMBean, SolrMetricProducer

A SolrInfoMBean that provides introspection of the Solr FieldCache

Nested Class Summary

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

SolrInfoMBean.Category, SolrInfoMBean.Group

Constructor Summary

Constructors

Constructor and Description
SolrFieldCacheMBean()

Method Summary

Modifier and Type	Method and Description
SolrInfoMBean.Category	getCategory() Purpose of this Class
String	getDescription() Simple one or two line description
URL[]	getDocs() Documentation URL list.
String	getName() Simple common usage name, e.g.
String	getSource() CVS Source, SVN Source, etc
NamedList	getStatistics() Any statistics this instance would like to be publicly available via the Solr Administration interface.
NamedList	getStatisticsForJmx() JMX-specific statistics
String	getVersion() Simple common usage version, e.g.
void	initializeMetrics(SolrMetricManager manager, String registryName, String scope) Initializes metrics specific to this producer

Methods inherited from class java.lang.Object

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

Constructor Detail

SolrFieldCacheMBean

public SolrFieldCacheMBean()

Method Detail

getName

public String getName()

Description copied from interface: SolrInfoMBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified clas name.

Specified by:

getName in interface SolrInfoMBean

getVersion

public String getVersion()

Description copied from interface: SolrInfoMBean

Simple common usage version, e.g. 2.0

Specified by:

getVersion in interface SolrInfoMBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

getCategory

public SolrInfoMBean.Category getCategory()

Description copied from interface: SolrInfoMBean

Purpose of this Class

Specified by:

getCategory in interface SolrInfoMBean

getSource

public String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

getDocs

public URL[] getDocs()

Description copied from interface: SolrInfoMBean

Documentation URL list.

Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...

Specified by:

getDocs in interface SolrInfoMBean

getStatistics

public NamedList getStatistics()

Description copied from interface: SolrInfoMBean

Any statistics this instance would like to be publicly available via the Solr Administration interface.

Any Object type may be stored in the list, but only the toString() representation will be used.

Specified by:

getStatistics in interface SolrInfoMBean

getStatisticsForJmx

public NamedList getStatisticsForJmx()

Description copied from interface: JmxMonitoredMap.JmxAugmentedSolrInfoMBean

JMX-specific statistics

Specified by:

getStatisticsForJmx in interface JmxMonitoredMap.JmxAugmentedSolrInfoMBean

initializeMetrics

public void initializeMetrics(SolrMetricManager manager,
                              String registryName,
                              String scope)

Description copied from interface: SolrMetricProducer

Initializes metrics specific to this producer

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

manager - an instance of SolrMetricManager

registryName - registry name where metrics are registered

scope - scope of the metrics (eg. handler name) to separate metrics of instances of the same component executing in different contexts