org.infinispan.configuration.global

Class GlobalJmxStatisticsConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.GlobalJmxStatisticsConfigurationBuilder

All Implemented Interfaces:

Builder<GlobalJmxStatisticsConfiguration>, GlobalConfigurationChildBuilder

public class GlobalJmxStatisticsConfigurationBuilder
extends Object
implements Builder<GlobalJmxStatisticsConfiguration>

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

Method Summary

Modifier and Type	Method and Description
GlobalJmxStatisticsConfigurationBuilder	addProperty(String key, String value)
GlobalJmxStatisticsConfigurationBuilder	allowDuplicateDomains(Boolean allowDuplicateDomains) If true, multiple cache manager instances could be configured under the same configured JMX domain.
ThreadPoolConfigurationBuilder	asyncThreadPool() Configuration for the asynchronous operations thread pool
GlobalConfiguration	build() Builds a GlobalConfiguration object using the settings applied to this builder
GlobalJmxStatisticsConfigurationBuilder	cacheManagerName(String cacheManagerName) If JMX statistics are enabled, this property represents the name of this cache manager.
GlobalJmxStatisticsConfiguration	create() Create the configuration bean
GlobalConfigurationBuilder	defaultCacheName(String defaultCacheName) Sets the name of the cache that acts as the default cache and is returned by CacheContainer.getCache().
GlobalJmxStatisticsConfigurationBuilder	disable()
GlobalJmxStatisticsConfigurationBuilder	enable()
GlobalJmxStatisticsConfigurationBuilder	enabled(boolean enabled)
ThreadPoolConfigurationBuilder	evictionThreadPool() Deprecated.
ThreadPoolConfigurationBuilder	expirationThreadPool() Configuration for the expiration thread pool
protected GlobalConfigurationBuilder	getGlobalConfig()
GlobalJmxStatisticsConfigurationBuilder	globalJmxStatistics() Global JMX configuration
GlobalStateConfigurationBuilder	globalState() Global state configuration
GlobalJmxStatisticsConfigurationBuilder	jmxDomain(String jmxDomain) If JMX statistics are enabled then all 'published' JMX objects will appear under this name.
ThreadPoolConfigurationBuilder	listenerThreadPool() Configuration for the listener thread pool
GlobalJmxStatisticsConfigurationBuilder	mBeanServerLookup(MBeanServerLookup mBeanServerLookupInstance) Sets the instance of the MBeanServerLookup class to be used to bound JMX MBeans to.
List<Builder<?>>	modules() Global modules configuration
ThreadPoolConfigurationBuilder	persistenceThreadPool() Configuration for the persistence thread pool
GlobalJmxStatisticsConfigurationBuilder	read(GlobalJmxStatisticsConfiguration template) Reads the configuration from an already created configuration bean into this builder.
ThreadPoolConfigurationBuilder	replicationQueueThreadPool()
GlobalSecurityConfigurationBuilder	security() Security-related configuration
SerializationConfigurationBuilder	serialization() Global serialization (i.e.
ShutdownConfigurationBuilder	shutdown() Shutdown configuration
SiteConfigurationBuilder	site() Cross-site replication configuration
ThreadPoolConfigurationBuilder	stateTransferThreadPool() Configuration for the state-transfer thread pool
String	toString()
TransportConfigurationBuilder	transport() Transport-related (i.e.
void	validate() Validate the data in this builder before building the configuration bean
GlobalJmxStatisticsConfigurationBuilder	withProperties(Properties properties) Sets properties which are then passed to the MBean Server Lookup implementation specified.

Methods inherited from class java.lang.Object

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

Method Detail

withProperties

public GlobalJmxStatisticsConfigurationBuilder withProperties(Properties properties)

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

Parameters:

properties - properties to pass to the MBean Server Lookup

addProperty

public GlobalJmxStatisticsConfigurationBuilder addProperty(String key,
                                                           String value)

jmxDomain

public GlobalJmxStatisticsConfigurationBuilder jmxDomain(String jmxDomain)

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.

Parameters:

jmxDomain -

allowDuplicateDomains

public GlobalJmxStatisticsConfigurationBuilder allowDuplicateDomains(Boolean allowDuplicateDomains)

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.

Parameters:

allowDuplicateDomains -

cacheManagerName

public GlobalJmxStatisticsConfigurationBuilder cacheManagerName(String cacheManagerName)

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.

Parameters:

cacheManagerName -

mBeanServerLookup

public GlobalJmxStatisticsConfigurationBuilder mBeanServerLookup(MBeanServerLookup mBeanServerLookupInstance)

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

Parameters:

mBeanServerLookupInstance - An instance of MBeanServerLookup

disable

public GlobalJmxStatisticsConfigurationBuilder disable()

enable

public GlobalJmxStatisticsConfigurationBuilder enable()

enabled

public GlobalJmxStatisticsConfigurationBuilder enabled(boolean enabled)

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<GlobalJmxStatisticsConfiguration>

create

public GlobalJmxStatisticsConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<GlobalJmxStatisticsConfiguration>

Returns:

read

public GlobalJmxStatisticsConfigurationBuilder read(GlobalJmxStatisticsConfiguration template)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<GlobalJmxStatisticsConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

toString

public String toString()

Overrides:

toString in class Object

getGlobalConfig

protected GlobalConfigurationBuilder getGlobalConfig()

transport

public TransportConfigurationBuilder transport()

Description copied from interface: GlobalConfigurationChildBuilder

Transport-related (i.e. clustering) configuration

Specified by:

transport in interface GlobalConfigurationChildBuilder

globalJmxStatistics

public GlobalJmxStatisticsConfigurationBuilder globalJmxStatistics()

Description copied from interface: GlobalConfigurationChildBuilder

Global JMX configuration

Specified by:

globalJmxStatistics in interface GlobalConfigurationChildBuilder

globalState

public GlobalStateConfigurationBuilder globalState()

Description copied from interface: GlobalConfigurationChildBuilder

Global state configuration

Specified by:

globalState in interface GlobalConfigurationChildBuilder

serialization

public SerializationConfigurationBuilder serialization()

Description copied from interface: GlobalConfigurationChildBuilder

Global serialization (i.e. marshalling) configuration

Specified by:

serialization in interface GlobalConfigurationChildBuilder

listenerThreadPool

public ThreadPoolConfigurationBuilder listenerThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the listener thread pool

Specified by:

listenerThreadPool in interface GlobalConfigurationChildBuilder

asyncThreadPool

public ThreadPoolConfigurationBuilder asyncThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the asynchronous operations thread pool

Specified by:

asyncThreadPool in interface GlobalConfigurationChildBuilder

replicationQueueThreadPool

public ThreadPoolConfigurationBuilder replicationQueueThreadPool()

Specified by:

replicationQueueThreadPool in interface GlobalConfigurationChildBuilder

evictionThreadPool

@Deprecated
public ThreadPoolConfigurationBuilder evictionThreadPool()

Deprecated.

Description copied from interface: GlobalConfigurationChildBuilder

Please use GlobalConfigurationChildBuilder.expirationThreadPool()

Specified by:

evictionThreadPool in interface GlobalConfigurationChildBuilder

expirationThreadPool

public ThreadPoolConfigurationBuilder expirationThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the expiration thread pool

Specified by:

expirationThreadPool in interface GlobalConfigurationChildBuilder

persistenceThreadPool

public ThreadPoolConfigurationBuilder persistenceThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the persistence thread pool

Specified by:

persistenceThreadPool in interface GlobalConfigurationChildBuilder

stateTransferThreadPool

public ThreadPoolConfigurationBuilder stateTransferThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the state-transfer thread pool

Specified by:

stateTransferThreadPool in interface GlobalConfigurationChildBuilder

security

public GlobalSecurityConfigurationBuilder security()

Description copied from interface: GlobalConfigurationChildBuilder

Security-related configuration

Specified by:

security in interface GlobalConfigurationChildBuilder

shutdown

public ShutdownConfigurationBuilder shutdown()

Description copied from interface: GlobalConfigurationChildBuilder

Shutdown configuration

Specified by:

shutdown in interface GlobalConfigurationChildBuilder

site

public SiteConfigurationBuilder site()

Description copied from interface: GlobalConfigurationChildBuilder

Cross-site replication configuration

Specified by:

site in interface GlobalConfigurationChildBuilder

modules

public List<Builder<?>> modules()

Description copied from interface: GlobalConfigurationChildBuilder

Global modules configuration

Specified by:

modules in interface GlobalConfigurationChildBuilder

defaultCacheName

public GlobalConfigurationBuilder defaultCacheName(String defaultCacheName)

Description copied from interface: GlobalConfigurationChildBuilder

Sets the name of the cache that acts as the default cache and is returned by CacheContainer.getCache(). Not

Specified by:

defaultCacheName in interface GlobalConfigurationChildBuilder

build

public GlobalConfiguration build()

Description copied from interface: GlobalConfigurationChildBuilder

Builds a GlobalConfiguration object using the settings applied to this builder

Specified by:

build in interface GlobalConfigurationChildBuilder