Package org.infinispan.configuration.global

Class GlobalJmxConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.GlobalJmxStatisticsConfigurationBuilder

org.infinispan.configuration.global.GlobalJmxConfigurationBuilder

All Implemented Interfaces:

Builder<GlobalJmxConfiguration>, GlobalConfigurationChildBuilder

public class GlobalJmxConfigurationBuilder
extends GlobalJmxStatisticsConfigurationBuilder
implements Builder<GlobalJmxConfiguration>

Configures JMX for the cache manager and its caches.

Since:

10.1.3

Method Summary

Modifier and Type	Method	Description
GlobalJmxConfigurationBuilder	addProperty(String key, String value)
ThreadPoolConfigurationBuilder	asyncThreadPool()	Configuration for the asynchronous operations thread pool
AttributeSet	attributes()
ThreadPoolConfigurationBuilder	blockingThreadPool()	Configuration for the blocking thread pool
GlobalConfiguration	build()	Builds a GlobalConfiguration object using the settings applied to this builder
GlobalJmxConfigurationBuilder	cacheManagerName(String cacheManagerName)	Deprecated, for removal: This API element is subject to removal in a future version. Use GlobalConfigurationBuilder.cacheManagerName(String) instead
GlobalJmxConfiguration	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 EmbeddedCacheManager.getCache().
GlobalJmxConfigurationBuilder	disable()	Disables JMX in the cache manager.
GlobalJmxConfigurationBuilder	domain(String domain)	If JMX is enabled then all 'published' JMX objects will appear under this name.
GlobalJmxConfigurationBuilder	enable()	Enables JMX in the cache manager.
boolean	enabled()
GlobalJmxConfigurationBuilder	enabled(boolean enabled)	Enables JMX in the cache manager.
ThreadPoolConfigurationBuilder	expirationThreadPool()	Configuration for the expiration thread pool
protected GlobalConfigurationBuilder	getGlobalConfig()
GlobalStateConfigurationBuilder	globalState()	Global state configuration
GlobalJmxConfigurationBuilder	jmx()	Global JMX configuration.
ThreadPoolConfigurationBuilder	listenerThreadPool()	Configuration for the listener thread pool
GlobalJmxConfigurationBuilder	mBeanServerLookup(MBeanServerLookup mBeanServerLookupInstance)	Sets the instance of the MBeanServerLookup class to be used to bound JMX MBeans to.
GlobalMetricsConfigurationBuilder	metrics()	Global metrics configuration.
List<Builder<?>>	modules()	Global modules configuration
ThreadPoolConfigurationBuilder	nonBlockingThreadPool()	Configuration for the non blocking thread pool
ThreadPoolConfigurationBuilder	persistenceThreadPool()	Configuration for the persistence thread pool
GlobalJmxConfigurationBuilder	read(GlobalJmxConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
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.
GlobalJmxConfigurationBuilder	withProperties(Properties properties)	Sets properties which are then passed to the MBean Server Lookup implementation specified.

Methods inherited from class org.infinispan.configuration.global.GlobalJmxStatisticsConfigurationBuilder

jmxDomain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset, validate

Methods inherited from interface org.infinispan.configuration.global.GlobalConfigurationChildBuilder

globalJmxStatistics

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<GlobalJmxConfiguration>

withProperties

public GlobalJmxConfigurationBuilder withProperties(Properties properties)

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

Specified by:

withProperties in class GlobalJmxStatisticsConfigurationBuilder

Parameters:

properties - properties to pass to the MBean Server Lookup

addProperty

public GlobalJmxConfigurationBuilder addProperty(String key,
 String value)

Specified by:

addProperty in class GlobalJmxStatisticsConfigurationBuilder

domain

public GlobalJmxConfigurationBuilder domain(String domain)

If JMX is enabled then all 'published' JMX objects will appear under this name. This is optional, if not specified a default domain name will be set by default.

Specified by:

domain in class GlobalJmxStatisticsConfigurationBuilder

Parameters:

domain -

cacheManagerName

@Deprecated(forRemoval=true)
public GlobalJmxConfigurationBuilder cacheManagerName(String cacheManagerName)

Deprecated, for removal: This API element is subject to removal in a future version.

Use GlobalConfigurationBuilder.cacheManagerName(String) instead

If JMX is 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 class GlobalJmxStatisticsConfigurationBuilder

mBeanServerLookup

public GlobalJmxConfigurationBuilder mBeanServerLookup(MBeanServerLookup mBeanServerLookupInstance)

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

Specified by:

mBeanServerLookup in class GlobalJmxStatisticsConfigurationBuilder

Parameters:

mBeanServerLookupInstance - An instance of MBeanServerLookup

disable

public GlobalJmxConfigurationBuilder disable()

Disables JMX in the cache manager.

Specified by:

disable in class GlobalJmxStatisticsConfigurationBuilder

enable

public GlobalJmxConfigurationBuilder enable()

Enables JMX in the cache manager.

Specified by:

enable in class GlobalJmxStatisticsConfigurationBuilder

enabled

public GlobalJmxConfigurationBuilder enabled(boolean enabled)

Enables JMX in the cache manager.

Specified by:

enabled in class GlobalJmxStatisticsConfigurationBuilder

enabled

public boolean enabled()

create

public GlobalJmxConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<GlobalJmxConfiguration>

Returns:

read

public GlobalJmxConfigurationBuilder read(GlobalJmxConfiguration template,
 Combine combine)

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<GlobalJmxConfiguration>

Parameters:

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

combine - the way attributes and children of this instance and the template should be combined.

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

metrics

public GlobalMetricsConfigurationBuilder metrics()

Description copied from interface: GlobalConfigurationChildBuilder

Global metrics configuration.

Specified by:

metrics in interface GlobalConfigurationChildBuilder

jmx

public GlobalJmxConfigurationBuilder jmx()

Description copied from interface: GlobalConfigurationChildBuilder

Global JMX configuration.

Specified by:

jmx 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

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

blockingThreadPool

public ThreadPoolConfigurationBuilder blockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the blocking thread pool

Specified by:

blockingThreadPool in interface GlobalConfigurationChildBuilder

nonBlockingThreadPool

public ThreadPoolConfigurationBuilder nonBlockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the non blocking thread pool

Specified by:

nonBlockingThreadPool 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 EmbeddedCacheManager.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