org.infinispan.config
Class GlobalConfiguration.GlobalJmxStatisticsType

java.lang.Object
  extended by org.infinispan.config.AbstractConfigurationBean
      extended by org.infinispan.config.GlobalConfiguration.GlobalJmxStatisticsType
All Implemented Interfaces:
Serializable, Cloneable, CloneableConfigurationComponent, GlobalConfiguration.GlobalJmxStatisticsConfig, JAXBUnmarshallable
Enclosing class:
GlobalConfiguration

public static class GlobalConfiguration.GlobalJmxStatisticsType
extends AbstractConfigurationBean
implements GlobalConfiguration.GlobalJmxStatisticsConfig

This element specifies whether global statistics are gathered and reported via JMX for all caches under this cache manager.

See Also:
Configuration reference, Serialized Form

Field Summary
protected  Boolean allowDuplicateDomains
           
protected  String cacheManagerName
           
protected  Boolean enabled
           
protected  String jmxDomain
           
protected  String mBeanServerLookup
           
protected  TypedProperties properties
           
 
Fields inherited from class org.infinispan.config.AbstractConfigurationBean
EMPTY_PROPERTIES, log, overriddenConfigurationElements
 
Constructor Summary
GlobalConfiguration.GlobalJmxStatisticsType()
           
 
Method Summary
 void accept(ConfigurationBeanVisitor v)
           
 GlobalConfiguration.GlobalJmxStatisticsConfig allowDuplicateDomains(Boolean allowDuplicateDomains)
          If true, multiple cache manager instances could be configured under the same configured JMX domain.
 GlobalConfiguration.GlobalJmxStatisticsConfig cacheManagerName(String cacheManagerName)
          If JMX statistics are enabled, this property represents the name of this cache manager.
 CloneableConfigurationComponent clone()
           
 GlobalConfiguration.GlobalJmxStatisticsConfig enabled(Boolean enabled)
          Toggle to enable/disable global statistics being exported via JMX
 MBeanServerLookup getMBeanServerLookupInstance()
           
protected  boolean hasComponentStarted()
          Tests whether the component this configuration bean intents to configure has already started.
 void inject(GlobalComponentRegistry gcr)
           
 GlobalConfiguration.GlobalJmxStatisticsConfig jmxDomain(String jmxDomain)
          If JMX statistics are enabled then all 'published' JMX objects will appear under this name.
 GlobalConfiguration.GlobalJmxStatisticsConfig mBeanServerLookup(Class<? extends MBeanServerLookup> beanServerLookupClass)
          Instance of class that will attempt to locate a JMX MBean server to bind to
 void setAllowDuplicateDomains(Boolean allowDuplicateDomains)
           
 void setCacheManagerName(String cacheManagerName)
           
 void setEnabled(Boolean enabled)
           
 void setJmxDomain(String jmxDomain)
           
 void setMBeanServerLookup(String beanServerLookup)
           
 void setMBeanServerLookupInstance(MBeanServerLookup MBeanServerLookupInstance)
           
 GlobalConfiguration.GlobalJmxStatisticsConfig setProperties(Properties p)
          Sets properties which are then passed to the MBean Server Lookup implementation specified.
 void setProperties(TypedProperties p)
           
 GlobalConfiguration.GlobalJmxStatisticsConfig usingMBeanServerLookupInstance(MBeanServerLookup MBeanServerLookupInstance)
          Sets the instance of the MBeanServerLookup class to be used to bound JMX MBeans to.
 
Methods inherited from class org.infinispan.config.AbstractConfigurationBean
testImmutability, toTypedProperties, toTypedProperties, uc, willUnmarshall
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

enabled

protected Boolean enabled

jmxDomain

protected String jmxDomain

mBeanServerLookup

protected String mBeanServerLookup

allowDuplicateDomains

protected Boolean allowDuplicateDomains

cacheManagerName

protected String cacheManagerName

properties

protected TypedProperties properties
Constructor Detail

GlobalConfiguration.GlobalJmxStatisticsType

public GlobalConfiguration.GlobalJmxStatisticsType()
Method Detail

enabled

public GlobalConfiguration.GlobalJmxStatisticsConfig enabled(Boolean enabled)
Description copied from interface: GlobalConfiguration.GlobalJmxStatisticsConfig
Toggle to enable/disable global statistics being exported via JMX

Specified by:
enabled in interface GlobalConfiguration.GlobalJmxStatisticsConfig

setEnabled

public void setEnabled(Boolean enabled)

accept

public void accept(ConfigurationBeanVisitor v)

setProperties

public void setProperties(TypedProperties p)

jmxDomain

public GlobalConfiguration.GlobalJmxStatisticsConfig jmxDomain(String jmxDomain)
Description copied from interface: GlobalConfiguration.GlobalJmxStatisticsConfig
If JMX statistics are enabled then all 'published' JMX objects will appear under this name. This is optional, if not specified an object name will be created for you by default.

Specified by:
jmxDomain in interface GlobalConfiguration.GlobalJmxStatisticsConfig

setJmxDomain

public void setJmxDomain(String jmxDomain)

mBeanServerLookup

public GlobalConfiguration.GlobalJmxStatisticsConfig mBeanServerLookup(Class<? extends MBeanServerLookup> beanServerLookupClass)
Description copied from interface: GlobalConfiguration.GlobalJmxStatisticsConfig
Instance of class that will attempt to locate a JMX MBean server to bind to

Specified by:
mBeanServerLookup in interface GlobalConfiguration.GlobalJmxStatisticsConfig

setMBeanServerLookup

public void setMBeanServerLookup(String beanServerLookup)

allowDuplicateDomains

public GlobalConfiguration.GlobalJmxStatisticsConfig allowDuplicateDomains(Boolean allowDuplicateDomains)
Description copied from interface: GlobalConfiguration.GlobalJmxStatisticsConfig
If true, multiple cache manager instances could be configured under the same configured JMX domain. Each cache manager will in practice use a different JMX domain that has been calculated based on the configured one by adding an incrementing index to it.

Specified by:
allowDuplicateDomains in interface GlobalConfiguration.GlobalJmxStatisticsConfig

setAllowDuplicateDomains

public void setAllowDuplicateDomains(Boolean allowDuplicateDomains)

cacheManagerName

public GlobalConfiguration.GlobalJmxStatisticsConfig cacheManagerName(String cacheManagerName)
Description copied from interface: GlobalConfiguration.GlobalJmxStatisticsConfig
If JMX statistics are enabled, this property represents the name of this cache manager. It offers the possibility for clients to provide a user-defined name to the cache manager which later can be used to identify the cache manager within a JMX based management tool amongst other cache managers that might be running under the same JVM.

Specified by:
cacheManagerName in interface GlobalConfiguration.GlobalJmxStatisticsConfig

setCacheManagerName

public void setCacheManagerName(String cacheManagerName)

getMBeanServerLookupInstance

public MBeanServerLookup getMBeanServerLookupInstance()

setMBeanServerLookupInstance

public void setMBeanServerLookupInstance(MBeanServerLookup MBeanServerLookupInstance)

setProperties

public GlobalConfiguration.GlobalJmxStatisticsConfig setProperties(Properties p)
Description copied from interface: GlobalConfiguration.GlobalJmxStatisticsConfig
Sets properties which are then passed to the MBean Server Lookup implementation specified.

Specified by:
setProperties in interface GlobalConfiguration.GlobalJmxStatisticsConfig

usingMBeanServerLookupInstance

public GlobalConfiguration.GlobalJmxStatisticsConfig usingMBeanServerLookupInstance(MBeanServerLookup MBeanServerLookupInstance)
Description copied from interface: GlobalConfiguration.GlobalJmxStatisticsConfig
Sets the instance of the MBeanServerLookup class to be used to bound JMX MBeans to.

Specified by:
usingMBeanServerLookupInstance in interface GlobalConfiguration.GlobalJmxStatisticsConfig

inject

public void inject(GlobalComponentRegistry gcr)

hasComponentStarted

protected boolean hasComponentStarted()
Description copied from class: AbstractConfigurationBean
Tests whether the component this configuration bean intents to configure has already started.

Specified by:
hasComponentStarted in class AbstractConfigurationBean
Returns:
true if the component has started; false otherwise.

clone

public CloneableConfigurationComponent clone()
                                      throws CloneNotSupportedException
Specified by:
clone in interface CloneableConfigurationComponent
Overrides:
clone in class AbstractConfigurationBean
Throws:
CloneNotSupportedException


Copyright © 2011 JBoss, a division of Red Hat. All Rights Reserved.