org.infinispan.config
Class GlobalConfiguration.GlobalJmxStatisticsType

java.lang.Object
  org.infinispan.config.AbstractConfigurationBean
      org.infinispan.config.GlobalConfiguration.GlobalJmxStatisticsType

All Implemented Interfaces:

Serializable, Cloneable, CloneableConfigurationComponent, FluentGlobalConfiguration.GlobalJmxStatisticsConfig, JAXBUnmarshallable

Enclosing class:

GlobalConfiguration

public static class GlobalConfiguration.GlobalJmxStatisticsType
extends AbstractConfigurationBean
implements FluentGlobalConfiguration.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

overriddenConfigurationElements

Constructor Summary

GlobalConfiguration.GlobalJmxStatisticsType()

Method Summary

void	accept(ConfigurationBeanVisitor v)
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	addProperty(String key, String value)
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	allowDuplicateDomains(Boolean allowDuplicateDomains) If true, multiple cache manager instances could be configured under the same configured JMX domain.
FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory>	asyncListenerExecutor()
FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory>	asyncListenerExecutor()
FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory>	asyncTransportExecutor()
FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory>	asyncTransportExecutor()
GlobalConfiguration	build()
GlobalConfiguration	build()
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	cacheManagerName(String cacheManagerName) If JMX statistics are enabled, this property represents the name of this cache manager.
CloneableConfigurationComponent	clone()
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	disable()
FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory>	evictionScheduledExecutor()
FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory>	evictionScheduledExecutor()
Boolean	getAllowDuplicateDomains()
String	getCacheManagerName()
Boolean	getEnabled()
String	getJmxDomain()
String	getMBeanServerLookup()
MBeanServerLookup	getMBeanServerLookupInstance()
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	globalJmxStatistics() This method allows configuration of the global, or cache manager level, jmx statistics.
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	globalJmxStatistics() This method allows configuration of the global, or cache manager level, jmx statistics.
protected boolean	hasComponentStarted() Tests whether the component this configuration bean intents to configure has already started.
void	inject(GlobalComponentRegistry gcr, GlobalConfiguration globalConfig)
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	jmxDomain(String jmxDomain) If JMX statistics are enabled then all 'published' JMX objects will appear under this name.
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	mBeanServerLookup(MBeanServerLookup MBeanServerLookupInstance) Sets the instance of the MBeanServerLookup class to be used to bound JMX MBeans to.
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	mBeanServerLookupClass(Class<? extends MBeanServerLookup> beanServerLookupClass) Instance of class that will attempt to locate a JMX MBean server to bind to
FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory>	replicationQueueScheduledExecutor()
FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory>	replicationQueueScheduledExecutor()
FluentGlobalConfiguration.SerializationConfig	serialization()
FluentGlobalConfiguration.SerializationConfig	serialization()
void	setAllowDuplicateDomains(Boolean allowDuplicateDomains) Deprecated. The visibility of this will be reduced, use allowDuplicateDomains(Boolean) instead
void	setCacheManagerName(String cacheManagerName) Deprecated. The visibility of this will be reduced, use cacheManagerName(String) instead
void	setEnabled(Boolean enabled) Deprecated. The visibility of this will be reduced, use AbstractConfigurationBeanWithGCR.globalJmxStatistics() instead
void	setJmxDomain(String jmxDomain) Deprecated. The visibility of this will be reduced, use jmxDomain(String) instead
void	setMBeanServerLookup(String beanServerLookup) Deprecated. The visibility of this will be reduced, use mBeanServerLookupClass(Class) instead
void	setMBeanServerLookupInstance(MBeanServerLookup MBeanServerLookupInstance) Deprecated. The visibility of this will be reduced, use mBeanServerLookup(org.infinispan.jmx.MBeanServerLookup) instead
void	setProperties(TypedProperties p) Deprecated. The visibility of this will be reduced, use withProperties(java.util.Properties) instead
FluentGlobalConfiguration.ShutdownConfig	shutdown()
FluentGlobalConfiguration.ShutdownConfig	shutdown()
FluentGlobalConfiguration.TransportConfig	transport()
FluentGlobalConfiguration.TransportConfig	transport()
FluentGlobalConfiguration.GlobalJmxStatisticsConfig	withProperties(Properties p) Sets properties which are then passed to the MBean Server Lookup implementation specified.

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

accept

public void accept(ConfigurationBeanVisitor v)

getEnabled

public Boolean getEnabled()

setEnabled

@Deprecated
public void setEnabled(Boolean enabled)

Deprecated. The visibility of this will be reduced, use AbstractConfigurationBeanWithGCR.globalJmxStatistics() instead

setProperties

@Deprecated
public void setProperties(TypedProperties p)

Deprecated. The visibility of this will be reduced, use withProperties(java.util.Properties) instead

withProperties

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig withProperties(Properties p)

Description copied from interface: FluentGlobalConfiguration.GlobalJmxStatisticsConfig

Sets properties which are then passed to the MBean Server Lookup implementation specified.

Specified by:

withProperties in interface FluentGlobalConfiguration.GlobalJmxStatisticsConfig

Parameters:

p - properties to pass to the MBean Server Lookup

addProperty

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig addProperty(String key,
                                                                       String value)

Specified by:

addProperty in interface FluentGlobalConfiguration.GlobalJmxStatisticsConfig

getJmxDomain

public String getJmxDomain()

setJmxDomain

@Deprecated
public void setJmxDomain(String jmxDomain)

Deprecated. The visibility of this will be reduced, use jmxDomain(String) instead

jmxDomain

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig jmxDomain(String jmxDomain)

Description copied from interface: FluentGlobalConfiguration.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 FluentGlobalConfiguration.GlobalJmxStatisticsConfig

getMBeanServerLookup

public String getMBeanServerLookup()

setMBeanServerLookup

@Deprecated
public void setMBeanServerLookup(String beanServerLookup)

Deprecated. The visibility of this will be reduced, use mBeanServerLookupClass(Class) instead

mBeanServerLookupClass

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig mBeanServerLookupClass(Class<? extends MBeanServerLookup> beanServerLookupClass)

Description copied from interface: FluentGlobalConfiguration.GlobalJmxStatisticsConfig

Instance of class that will attempt to locate a JMX MBean server to bind to

Specified by:

mBeanServerLookupClass in interface FluentGlobalConfiguration.GlobalJmxStatisticsConfig

Parameters:

beanServerLookupClass - MBean Server Lookup class implementation

getAllowDuplicateDomains

public Boolean getAllowDuplicateDomains()

setAllowDuplicateDomains

@Deprecated
public void setAllowDuplicateDomains(Boolean allowDuplicateDomains)

Deprecated. The visibility of this will be reduced, use allowDuplicateDomains(Boolean) instead

allowDuplicateDomains

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig allowDuplicateDomains(Boolean allowDuplicateDomains)

Description copied from interface: FluentGlobalConfiguration.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 FluentGlobalConfiguration.GlobalJmxStatisticsConfig

getCacheManagerName

public String getCacheManagerName()

setCacheManagerName

@Deprecated
public void setCacheManagerName(String cacheManagerName)

Deprecated. The visibility of this will be reduced, use cacheManagerName(String) instead

cacheManagerName

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig cacheManagerName(String cacheManagerName)

Description copied from interface: FluentGlobalConfiguration.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 FluentGlobalConfiguration.GlobalJmxStatisticsConfig

getMBeanServerLookupInstance

public MBeanServerLookup getMBeanServerLookupInstance()

disable

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig disable()

Specified by:

disable in interface FluentGlobalConfiguration.GlobalJmxStatisticsConfig

setMBeanServerLookupInstance

@Deprecated
public void setMBeanServerLookupInstance(MBeanServerLookup MBeanServerLookupInstance)

Deprecated. The visibility of this will be reduced, use mBeanServerLookup(org.infinispan.jmx.MBeanServerLookup) instead

mBeanServerLookup

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig mBeanServerLookup(MBeanServerLookup MBeanServerLookupInstance)

Description copied from interface: FluentGlobalConfiguration.GlobalJmxStatisticsConfig

Sets the instance of the MBeanServerLookup class to be used to bound JMX MBeans to.

Specified by:

mBeanServerLookup in interface FluentGlobalConfiguration.GlobalJmxStatisticsConfig

Parameters:

MBeanServerLookupInstance - An instance of MBeanServerLookup

transport

public FluentGlobalConfiguration.TransportConfig transport()

globalJmxStatistics

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig globalJmxStatistics()

This method allows configuration of the global, or cache manager level, jmx statistics. When this method is called, it automatically enables global jmx statistics. So, if you want it to be disabled, make sure you call FluentGlobalConfiguration.GlobalJmxStatisticsConfig.disable()

serialization

public FluentGlobalConfiguration.SerializationConfig serialization()

asyncTransportExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory> asyncTransportExecutor()

asyncListenerExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory> asyncListenerExecutor()

evictionScheduledExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory> evictionScheduledExecutor()

replicationQueueScheduledExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory> replicationQueueScheduledExecutor()

shutdown

public FluentGlobalConfiguration.ShutdownConfig shutdown()

build

public GlobalConfiguration build()

inject

public void inject(GlobalComponentRegistry gcr,
                   GlobalConfiguration globalConfig)

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

transport

public FluentGlobalConfiguration.TransportConfig transport()

globalJmxStatistics

public FluentGlobalConfiguration.GlobalJmxStatisticsConfig globalJmxStatistics()

This method allows configuration of the global, or cache manager level, jmx statistics. When this method is called, it automatically enables global jmx statistics. So, if you want it to be disabled, make sure you call FluentGlobalConfiguration.GlobalJmxStatisticsConfig.disable()

serialization

public FluentGlobalConfiguration.SerializationConfig serialization()

asyncListenerExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory> asyncListenerExecutor()

asyncTransportExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ExecutorFactory> asyncTransportExecutor()

evictionScheduledExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory> evictionScheduledExecutor()

replicationQueueScheduledExecutor

public FluentGlobalConfiguration.ExecutorFactoryConfig<ScheduledExecutorFactory> replicationQueueScheduledExecutor()

shutdown

public FluentGlobalConfiguration.ShutdownConfig shutdown()

build

public GlobalConfiguration build()