Class GlobalJmxConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

org.infinispan.configuration.global.GlobalJmxConfigurationBuilder

All Implemented Interfaces:

Builder<GlobalJmxConfiguration>, GlobalConfigurationChildBuilder

public class GlobalJmxConfigurationBuilder
extends AbstractGlobalConfigurationBuilder
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)
AttributeSet	attributes()
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
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.
GlobalJmxConfigurationBuilder	mBeanServerLookup(MBeanServerLookup mBeanServerLookupInstance)	Sets the instance of the MBeanServerLookup class to be used to bound JMX MBeans to.
GlobalJmxConfigurationBuilder	read(GlobalJmxConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
String	toString()
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.AbstractGlobalConfigurationBuilder

addModule, asyncThreadPool, blockingThreadPool, build, clearModules, defaultCacheName, expirationThreadPool, getGlobalConfig, globalState, jmx, listenerThreadPool, metrics, module, modules, nonBlockingThreadPool, persistenceThreadPool, security, serialization, shutdown, site, tracing, transport

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

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.

Parameters:

properties - properties to pass to the MBean Server Lookup

addProperty

public GlobalJmxConfigurationBuilder addProperty(String key,
 String value)

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.

Parameters:

domain -

cacheManagerName

@Deprecated(forRemoval=true,
            since="10.1")
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.

mBeanServerLookup

public GlobalJmxConfigurationBuilder 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 GlobalJmxConfigurationBuilder disable()

Disables JMX in the cache manager.

enable

public GlobalJmxConfigurationBuilder enable()

Enables JMX in the cache manager.

enabled

public GlobalJmxConfigurationBuilder enabled(boolean enabled)

Enables JMX in the cache manager.

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