org.jboss.cache.jmx
Class CacheJmxWrapper<K,V>

java.lang.Object
  javax.management.NotificationBroadcasterSupport
      org.jboss.cache.jmx.CacheJmxWrapper<K,V>

All Implemented Interfaces:

javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, CacheJmxWrapperMBean<K,V>, CacheNotificationBroadcaster, LegacyConfiguration

public class CacheJmxWrapper<K,V>
extends javax.management.NotificationBroadcasterSupport
implements CacheJmxWrapperMBean<K,V>, javax.management.MBeanRegistration, CacheNotificationBroadcaster

Wrapper class that exposes a JMX management interface for an instance of CacheImpl.

Version:

$Revision: 1.30 $

Author:

Brian Stansberry

Field Summary

Fields inherited from interface org.jboss.cache.jmx.CacheJmxWrapperMBean

CREATED, DESTROYED, FAILED, REGISTERED, STARTED, STARTING, STOPPED, STOPPING, UNREGISTERED

Fields inherited from interface org.jboss.cache.jmx.CacheNotificationBroadcaster

NOTIF_CACHE_STARTED, NOTIF_CACHE_STOPPED, NOTIF_NODE_ACTIVATED, NOTIF_NODE_CREATED, NOTIF_NODE_EVICTED, NOTIF_NODE_LOADED, NOTIF_NODE_MODIFIED, NOTIF_NODE_MOVED, NOTIF_NODE_PASSIVATED, NOTIF_NODE_REMOVED, NOTIF_NODE_VISITED, NOTIF_VIEW_CHANGED

Constructor Summary

CacheJmxWrapper()

CacheJmxWrapper(Cache<K,V> cache)

Method Summary

void	addNotificationListener(javax.management.NotificationListener notificationListener, javax.management.NotificationFilter notificationFilter, java.lang.Object object)
protected void	constructCache()
void	create()
void	destroy()
static java.lang.String	formatHtml(java.lang.String s) Formats a given String for display as an HTML snippet.
org.w3c.dom.Element	getBuddyReplicationConfig() Retrieves the buddy replication configuration element
Cache<K,V>	getCache() Retrieves a reference to the underlying Cache
java.lang.String	getCacheDetails()
java.lang.String	getCacheDetailsAsHtml()
org.w3c.dom.Element	getCacheLoaderConfig() Retrieves the cache loader configuration element
org.w3c.dom.Element	getCacheLoaderConfiguration()
java.lang.String	getCacheMode() Returns the current caching mode.
java.lang.String	getCacheObjectName()
CacheStatus	getCacheStatus() Gets where this object is in its lifecycle transitions.
org.w3c.dom.Element	getClusterConfig() Gets the JGroups protocol stack config in W3C DOM Element form.
java.lang.String	getClusterName() Get the name of the replication group
java.lang.String	getClusterProperties() Get the cluster properties (e.g.
Configuration	getConfiguration()
java.lang.String	getConfigurationAsHtmlString()
java.lang.String	getConfigurationAsString()
org.w3c.dom.Element	getEvictionPolicyConfig()
boolean	getExposeManagementStatistics() Gets whether the cache should create interceptor mbeans that are used to capture and publish interceptor statistics.
boolean	getFetchInMemoryState() Returns whether or not any initial state transfer or subsequent partial state transfer following an activateRegion call should include in-memory state.
long	getInitialStateRetrievalTimeout() Deprecated.
java.lang.String	getIsolationLevel() Returns the transaction isolation level.
org.jgroups.Address	getLocalAddress() Returns the local address of this cache in a cluster, or null if running in local mode.
long	getLockAcquisitionTimeout() Default max time to wait for a lock.
java.lang.String	getLockInfo()
java.lang.String	getLockInfoAsHtml()
javax.management.MBeanServer	getMBeanServer()
java.util.List<org.jgroups.Address>	getMembers() Returns a list of members in the cluster, or null if running in local mode.
org.jgroups.jmx.JChannelFactoryMBean	getMultiplexerService()
java.lang.String	getMultiplexerStack() Retrieves the JGroups multiplexer stack name if defined.
org.jgroups.ChannelFactory	getMuxChannelFactory()
long	getNextNotificationSequenceNumber() Gets the sequence number for the next notification.
java.lang.String	getNodeLockingScheme()
javax.management.MBeanNotificationInfo[]	getNotificationInfo()
java.lang.String	getNotificationServiceName()
int	getNumberOfAttributes()
int	getNumberOfNodes()
boolean	getRegisterInterceptors() Gets whether this object should register the cache's interceptors with JMX during {@link #create()}.
java.lang.String	getReplicationVersion() Gets the format version of the data transferred during an initial state transfer or a call to Region.activate().
long	getReplQueueInterval()
int	getReplQueueMaxElements()
int	getState() Legacy attribute to expose the cache status in terms of the JBoss AS ServiceMBean values.
long	getStateRetrievalTimeout() Get the max time to wait until the state is retrieved.
boolean	getSyncCommitPhase()
long	getSyncReplTimeout() Returns the default max timeout after which synchronous replication calls return.
boolean	getSyncRollbackPhase()
javax.transaction.TransactionManager	getTransactionManager()
java.lang.String	getTransactionManagerLookupClass()
boolean	getUseInterceptorMbeans()
boolean	getUseRegionBasedMarshalling() Gets whether marshalling uses scoped class loaders on a per region basis.
boolean	getUseReplQueue()
boolean	isDisableStateChangeNotifications() Gets whether sending of JMX notifications for this mbean's start/stop lifecycle changes is disabled.
boolean	isInactiveOnStartup() Gets whether the entire tree is inactive upon startup, only responding to replication messages after activateRegion is called to activate one or more parts of the tree.
void	postDeregister() Unregisters the interceptors, if getRegisterInterceptors() is true.
void	postRegister(java.lang.Boolean registrationDone) Registers the cache's interceptors, if getRegisterInterceptors() is true.
void	preDeregister() No-op.
javax.management.ObjectName	preRegister(javax.management.MBeanServer server, javax.management.ObjectName objName) Caches the provided server and objName.
protected boolean	registerInterceptors()
void	removeNotificationListener(javax.management.NotificationListener notificationListener)
void	removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)
void	setBuddyReplicationConfig(org.w3c.dom.Element config) Sets the buddy replication configuration element
void	setCache(Cache<K,V> cache) Allows direct injection of the underlying cache.
void	setCacheLoaderConfig(org.w3c.dom.Element cache_loader_config)
void	setCacheLoaderConfiguration(org.w3c.dom.Element config)
void	setCacheMode(java.lang.String mode) Sets the default caching mode)
void	setCacheObjectName(java.lang.String name)
void	setClusterConfig(org.w3c.dom.Element config) Convert a list of elements to the JG property string
void	setClusterName(java.lang.String name) Set the name of the replication group
void	setClusterProperties(java.lang.String cluster_props) Set the cluster properties.
void	setConfiguration(Configuration config) Sets the configuration that the underlying cache should use.
void	setDisableStateChangeNotifications(boolean disableStateChangeNotifications) Hook to allow PojoCacheJmxWrapper to suppress state change notifications from this mbean in lieu of its own.
void	setEvictionPolicyConfig(org.w3c.dom.Element config) Setup eviction policy configuration
void	setExposeManagementStatistics(boolean expose)
void	setFetchInMemoryState(boolean flag) Sets whether or not any initial or subsequent partial state transfer should include in-memory state.
void	setInactiveOnStartup(boolean inactiveOnStartup) Sets whether the entire tree is inactive upon startup, only responding to replication messages after Region.activate() is called to activate one or more parts of the tree.
void	setInitialStateRetrievalTimeout(long timeout) Deprecated.
void	setIsolationLevel(java.lang.String level) Set the transaction isolation level.
void	setLockAcquisitionTimeout(long timeout) Set the max time for lock acquisition.
void	setMultiplexerService(org.jgroups.jmx.JChannelFactoryMBean muxService)
void	setMultiplexerStack(java.lang.String stackName) Used with JGroups multiplexer, specifies stack to be used (e.g., fc-fast-minimalthreads) This attribute is optional; if not provided, a default multiplexer stack will be used.
void	setMuxChannelFactory(org.jgroups.ChannelFactory factory)
void	setNodeLockingScheme(java.lang.String nodeLockingScheme)
void	setNotificationServiceName(java.lang.String notificationServiceName)
void	setRegisterInterceptors(boolean register) Sets whether this object should register the cache's interceptors with JMX during CacheJmxWrapperMBean.create().
void	setReplicationVersion(java.lang.String version) Sets the format version of the data transferred during an initial state transfer or a call to Region.activate().
void	setReplQueueInterval(long interval)
void	setReplQueueMaxElements(int max_elements)
void	setStateRetrievalTimeout(long timeout) Set the state transfer timeout (see LegacyConfiguration.getStateRetrievalTimeout())
void	setSyncCommitPhase(boolean sync_commit_phase)
void	setSyncReplTimeout(long timeout) Sets the default maximum wait time for synchronous replication to receive all results
void	setSyncRollbackPhase(boolean sync_rollback_phase)
void	setTransactionManager(javax.transaction.TransactionManager manager)
void	setTransactionManagerLookupClass(java.lang.String cl) Sets the class of the TransactionManagerLookup impl.
void	setUseInterceptorMbeans(boolean use)
void	setUseRegionBasedMarshalling(boolean isTrue) Sets whether marshalling uses scoped class loaders on a per region basis.
void	setUseReplQueue(boolean flag)
void	start()
void	stop()
protected void	unregisterInterceptors()

Methods inherited from class javax.management.NotificationBroadcasterSupport

handleNotification, sendNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.cache.jmx.CacheNotificationBroadcaster

sendNotification

Constructor Detail

CacheJmxWrapper

public CacheJmxWrapper()

CacheJmxWrapper

public CacheJmxWrapper(Cache<K,V> cache)

Method Detail

getCache

public Cache<K,V> getCache()

Description copied from interface: CacheJmxWrapperMBean

Retrieves a reference to the underlying Cache

Specified by:

getCache in interface CacheJmxWrapperMBean<K,V>

getConfiguration

public Configuration getConfiguration()

Specified by:

getConfiguration in interface CacheJmxWrapperMBean<K,V>

Returns:

an immutable configuration

getConfigurationAsString

public java.lang.String getConfigurationAsString()

Specified by:

getConfigurationAsString in interface CacheJmxWrapperMBean<K,V>

Returns:

a string based representation of the configuration

getConfigurationAsHtmlString

public java.lang.String getConfigurationAsHtmlString()

Specified by:

getConfigurationAsHtmlString in interface CacheJmxWrapperMBean<K,V>

Returns:

an HTML formatted string based representation of the configuration

getCacheDetails

public java.lang.String getCacheDetails()

Specified by:

getCacheDetails in interface CacheJmxWrapperMBean<K,V>

Returns:

details of nodes in the cache

getCacheDetailsAsHtml

public java.lang.String getCacheDetailsAsHtml()

Specified by:

getCacheDetailsAsHtml in interface CacheJmxWrapperMBean<K,V>

Returns:

details of nodes in the cache, formatted as HTML

getCacheStatus

public CacheStatus getCacheStatus()

Description copied from interface: CacheJmxWrapperMBean

Gets where this object is in its lifecycle transitions.

Specified by:

getCacheStatus in interface CacheJmxWrapperMBean<K,V>

Returns:

the current status. Will not return null

getState

public int getState()

Description copied from interface: CacheJmxWrapperMBean

Legacy attribute to expose the cache status in terms of the JBoss AS ServiceMBean values. This interface does not extend ServiceMBean, but this attribute is retained to provide compatibility with the JBoss AS JSR-77 integration layer.

Specified by:

getState in interface CacheJmxWrapperMBean<K,V>

Returns:

the current status, e.g. CacheJmxWrapperMBean.STARTED.

getLocalAddress

public org.jgroups.Address getLocalAddress()

Description copied from interface: CacheJmxWrapperMBean

Returns the local address of this cache in a cluster, or null if running in local mode.

Specified by:

getLocalAddress in interface CacheJmxWrapperMBean<K,V>

Returns:

the local address of this cache in a cluster, or null if running in local mode.

getMembers

public java.util.List<org.jgroups.Address> getMembers()

Description copied from interface: CacheJmxWrapperMBean

Returns a list of members in the cluster, or null if running in local mode.

Specified by:

getMembers in interface CacheJmxWrapperMBean<K,V>

Returns:

a List of members in the cluster, or null if running in local mode.

getNumberOfNodes

public int getNumberOfNodes()

Specified by:

getNumberOfNodes in interface CacheJmxWrapperMBean<K,V>

Returns:

number of nodes in the cache

getNumberOfAttributes

public int getNumberOfAttributes()

Specified by:

getNumberOfAttributes in interface CacheJmxWrapperMBean<K,V>

Returns:

number of attributes in the cache

getLockInfo

public java.lang.String getLockInfo()

Specified by:

getLockInfo in interface CacheJmxWrapperMBean<K,V>

Returns:

information on the state of node locks

getLockInfoAsHtml

public java.lang.String getLockInfoAsHtml()

Specified by:

getLockInfoAsHtml in interface CacheJmxWrapperMBean<K,V>

Returns:

information on the state of node locks, formatted as HTML

getRegisterInterceptors

public boolean getRegisterInterceptors()

Description copied from interface: CacheJmxWrapperMBean

Gets whether this object should register the cache's interceptors with JMX during {@link #create()}.

Default is true.

Specified by:

getRegisterInterceptors in interface CacheJmxWrapperMBean<K,V>

setRegisterInterceptors

public void setRegisterInterceptors(boolean register)

Description copied from interface: CacheJmxWrapperMBean

Sets whether this object should register the cache's interceptors with JMX during CacheJmxWrapperMBean.create().

Default is true.

Specified by:

setRegisterInterceptors in interface CacheJmxWrapperMBean<K,V>

getBuddyReplicationConfig

public org.w3c.dom.Element getBuddyReplicationConfig()

Description copied from interface: LegacyConfiguration

Retrieves the buddy replication configuration element

Specified by:

getBuddyReplicationConfig in interface LegacyConfiguration

Returns:

whatever was passed to LegacyConfiguration.setBuddyReplicationConfig(Element) or null if nothing was

getCacheLoaderConfig

public org.w3c.dom.Element getCacheLoaderConfig()

Description copied from interface: LegacyConfiguration

Retrieves the cache loader configuration element

Specified by:

getCacheLoaderConfig in interface LegacyConfiguration

Returns:

whatever was passed to LegacyConfiguration.setCacheLoaderConfig(Element) or null if nothing was

getCacheLoaderConfiguration

public org.w3c.dom.Element getCacheLoaderConfiguration()

Specified by:

getCacheLoaderConfiguration in interface LegacyConfiguration

getCacheMode

public java.lang.String getCacheMode()

Description copied from interface: LegacyConfiguration

Returns the current caching mode. Valid values are

• LOCAL
• REPL_ASYNC
• REPL_SYNC

  Specified by:

  getCacheMode in interface LegacyConfiguration

  Returns:

  String The caching mode

getClusterName

public java.lang.String getClusterName()

Description copied from interface: LegacyConfiguration

Get the name of the replication group

Specified by:

getClusterName in interface LegacyConfiguration

getClusterProperties

public java.lang.String getClusterProperties()

Description copied from interface: LegacyConfiguration

Get the cluster properties (e.g. the protocol stack specification in case of JGroups)

Specified by:

getClusterProperties in interface LegacyConfiguration

getClusterConfig

public org.w3c.dom.Element getClusterConfig()

Description copied from interface: LegacyConfiguration

Gets the JGroups protocol stack config in W3C DOM Element form.

Specified by:

getClusterConfig in interface LegacyConfiguration

Returns:

the protocol stack, or null if it was not set via LegacyConfiguration.setClusterConfig(Element)

getEvictionPolicyConfig

public org.w3c.dom.Element getEvictionPolicyConfig()

Specified by:

getEvictionPolicyConfig in interface LegacyConfiguration

Returns:

whatever was passed to LegacyConfiguration.setEvictionPolicyConfig(Element) or null if nothing was

getExposeManagementStatistics

public boolean getExposeManagementStatistics()

Description copied from interface: LegacyConfiguration

Gets whether the cache should create interceptor mbeans that are used to capture and publish interceptor statistics.

Specified by:

getExposeManagementStatistics in interface LegacyConfiguration

Returns:

true if mbeans should be created for each interceptor

getUseInterceptorMbeans

public boolean getUseInterceptorMbeans()

Specified by:

getUseInterceptorMbeans in interface LegacyConfiguration

getFetchInMemoryState

public boolean getFetchInMemoryState()

Description copied from interface: LegacyConfiguration

Returns whether or not any initial state transfer or subsequent partial state transfer following an activateRegion call should include in-memory state. Allows for warm/hot caches (true/false). The characteristics of a state transfer can be further defined by a cache loader's FetchPersistentState property.

Specified by:

getFetchInMemoryState in interface LegacyConfiguration

getStateRetrievalTimeout

public long getStateRetrievalTimeout()

Description copied from interface: LegacyConfiguration

Get the max time to wait until the state is retrieved. This is used in a replicating cache: when a new cache joins the cluster, it needs to acquire the (replicated) state of the other members to initialize itself. If no state has been received within timeout milliseconds, the map will be empty.

Specified by:

getStateRetrievalTimeout in interface LegacyConfiguration

Returns:

long Number of milliseconds to wait for the state. 0 means to wait forever.

setInitialStateRetrievalTimeout

@Deprecated
public void setInitialStateRetrievalTimeout(long timeout)

Deprecated.

Description copied from interface: LegacyConfiguration

Set the initial state transfer timeout (see LegacyConfiguration.getInitialStateRetrievalTimeout())

Specified by:

setInitialStateRetrievalTimeout in interface LegacyConfiguration

getIsolationLevel

public java.lang.String getIsolationLevel()

Description copied from interface: LegacyConfiguration

Returns the transaction isolation level.

Specified by:

getIsolationLevel in interface LegacyConfiguration

getLockAcquisitionTimeout

public long getLockAcquisitionTimeout()

Description copied from interface: LegacyConfiguration

Default max time to wait for a lock. If the lock cannot be acquired within this time, a LockingException will be thrown.

Specified by:

getLockAcquisitionTimeout in interface LegacyConfiguration

Returns:

long Max number of milliseconds to wait for a lock to be acquired

getMultiplexerService

public org.jgroups.jmx.JChannelFactoryMBean getMultiplexerService()

Specified by:

getMultiplexerService in interface LegacyConfiguration

getMultiplexerStack

public java.lang.String getMultiplexerStack()

Description copied from interface: LegacyConfiguration

Retrieves the JGroups multiplexer stack name if defined.

Specified by:

getMultiplexerStack in interface LegacyConfiguration

Returns:

the multiplexer stack name

getMuxChannelFactory

public org.jgroups.ChannelFactory getMuxChannelFactory()

Specified by:

getMuxChannelFactory in interface LegacyConfiguration

getNodeLockingScheme

public java.lang.String getNodeLockingScheme()

Specified by:

getNodeLockingScheme in interface LegacyConfiguration

getReplQueueInterval

public long getReplQueueInterval()

Specified by:

getReplQueueInterval in interface LegacyConfiguration

getReplQueueMaxElements

public int getReplQueueMaxElements()

Specified by:

getReplQueueMaxElements in interface LegacyConfiguration

getReplicationVersion

public java.lang.String getReplicationVersion()

Description copied from interface: LegacyConfiguration

Gets the format version of the data transferred during an initial state transfer or a call to Region.activate(). Different releases of JBossCache may format this data differently; this property identifies the format version being used by this cache instance.

The default value for this property is Configuration.DEFAULT_REPLICATION_VERSION.

Specified by:

getReplicationVersion in interface LegacyConfiguration

Returns:

a short identifying JBossCache release; e.g. 124 for JBossCache 1.2.4

getSyncCommitPhase

public boolean getSyncCommitPhase()

Specified by:

getSyncCommitPhase in interface LegacyConfiguration

getSyncReplTimeout

public long getSyncReplTimeout()

Description copied from interface: LegacyConfiguration

Returns the default max timeout after which synchronous replication calls return.

Specified by:

getSyncReplTimeout in interface LegacyConfiguration

Returns:

long Number of milliseconds after which a sync repl call must return. 0 means to wait forever

getSyncRollbackPhase

public boolean getSyncRollbackPhase()

Specified by:

getSyncRollbackPhase in interface LegacyConfiguration

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Specified by:

getTransactionManager in interface LegacyConfiguration

getTransactionManagerLookupClass

public java.lang.String getTransactionManagerLookupClass()

Specified by:

getTransactionManagerLookupClass in interface LegacyConfiguration

getUseRegionBasedMarshalling

public boolean getUseRegionBasedMarshalling()

Description copied from interface: LegacyConfiguration

Gets whether marshalling uses scoped class loaders on a per region basis.

Specified by:

getUseRegionBasedMarshalling in interface LegacyConfiguration

Returns:

true if region based marshalling is used.

getUseReplQueue

public boolean getUseReplQueue()

Specified by:

getUseReplQueue in interface LegacyConfiguration

isInactiveOnStartup

public boolean isInactiveOnStartup()

Description copied from interface: LegacyConfiguration

Gets whether the entire tree is inactive upon startup, only responding to replication messages after activateRegion is called to activate one or more parts of the tree.

This property is only relevant if Configuration.isUseRegionBasedMarshalling() is true.

Specified by:

isInactiveOnStartup in interface LegacyConfiguration

setBuddyReplicationConfig

public void setBuddyReplicationConfig(org.w3c.dom.Element config)

Description copied from interface: LegacyConfiguration

Sets the buddy replication configuration element

Specified by:

setBuddyReplicationConfig in interface LegacyConfiguration

setCacheLoaderConfig

public void setCacheLoaderConfig(org.w3c.dom.Element cache_loader_config)

Specified by:

setCacheLoaderConfig in interface LegacyConfiguration

setCacheLoaderConfiguration

public void setCacheLoaderConfiguration(org.w3c.dom.Element config)

Specified by:

setCacheLoaderConfiguration in interface LegacyConfiguration

setCacheMode

public void setCacheMode(java.lang.String mode)
                  throws java.lang.Exception

Description copied from interface: LegacyConfiguration

Sets the default caching mode)

Specified by:

setCacheMode in interface LegacyConfiguration

Throws:

java.lang.Exception

setClusterConfig

public void setClusterConfig(org.w3c.dom.Element config)

Description copied from interface: LegacyConfiguration

Convert a list of elements to the JG property string

Specified by:

setClusterConfig in interface LegacyConfiguration

getInitialStateRetrievalTimeout

@Deprecated
public long getInitialStateRetrievalTimeout()

Deprecated.

Description copied from interface: LegacyConfiguration

Get the max time to wait until the initial state is retrieved. This is used in a replicating cache: when a new cache joins the cluster, it needs to acquire the (replicated) state of the other members to initialize itself. If no state has been received within timeout milliseconds, the map will be empty.

Specified by:

getInitialStateRetrievalTimeout in interface LegacyConfiguration

Returns:

long Number of milliseconds to wait for the state. 0 means to wait forever.

setClusterName

public void setClusterName(java.lang.String name)

Description copied from interface: LegacyConfiguration

Set the name of the replication group

Specified by:

setClusterName in interface LegacyConfiguration

setClusterProperties

public void setClusterProperties(java.lang.String cluster_props)

Description copied from interface: LegacyConfiguration

Set the cluster properties. If the cache is to use the new properties, it has to be redeployed

Specified by:

setClusterProperties in interface LegacyConfiguration

Parameters:

cluster_props - The properties for the cluster (JGroups)

setEvictionPolicyConfig

public void setEvictionPolicyConfig(org.w3c.dom.Element config)

Description copied from interface: LegacyConfiguration

Setup eviction policy configuration

Specified by:

setEvictionPolicyConfig in interface LegacyConfiguration

setExposeManagementStatistics

public void setExposeManagementStatistics(boolean expose)

Specified by:

setExposeManagementStatistics in interface LegacyConfiguration

setUseInterceptorMbeans

public void setUseInterceptorMbeans(boolean use)

Specified by:

setUseInterceptorMbeans in interface LegacyConfiguration

setFetchInMemoryState

public void setFetchInMemoryState(boolean flag)

Description copied from interface: LegacyConfiguration

Sets whether or not any initial or subsequent partial state transfer should include in-memory state.

Specified by:

setFetchInMemoryState in interface LegacyConfiguration

setInactiveOnStartup

public void setInactiveOnStartup(boolean inactiveOnStartup)

Description copied from interface: LegacyConfiguration

Sets whether the entire tree is inactive upon startup, only responding to replication messages after Region.activate() is called to activate one or more parts of the tree.

This property is only relevant if Configuration.isUseRegionBasedMarshalling() is true.

Specified by:

setInactiveOnStartup in interface LegacyConfiguration

setStateRetrievalTimeout

public void setStateRetrievalTimeout(long timeout)

Description copied from interface: LegacyConfiguration

Set the state transfer timeout (see LegacyConfiguration.getStateRetrievalTimeout())

Specified by:

setStateRetrievalTimeout in interface LegacyConfiguration

setIsolationLevel

public void setIsolationLevel(java.lang.String level)

Description copied from interface: LegacyConfiguration

Set the transaction isolation level. This determines the locking strategy to be used

Specified by:

setIsolationLevel in interface LegacyConfiguration

setLockAcquisitionTimeout

public void setLockAcquisitionTimeout(long timeout)

Description copied from interface: LegacyConfiguration

Set the max time for lock acquisition. A value of 0 means to wait forever (not recomended). Note that lock acquisition timeouts may be removed in the future when we have deadlock detection.

Specified by:

setLockAcquisitionTimeout in interface LegacyConfiguration

setMultiplexerService

public void setMultiplexerService(org.jgroups.jmx.JChannelFactoryMBean muxService)

Specified by:

setMultiplexerService in interface LegacyConfiguration

setMultiplexerStack

public void setMultiplexerStack(java.lang.String stackName)

Description copied from interface: LegacyConfiguration

Used with JGroups multiplexer, specifies stack to be used (e.g., fc-fast-minimalthreads) This attribute is optional; if not provided, a default multiplexer stack will be used.

Specified by:

setMultiplexerStack in interface LegacyConfiguration

Parameters:

stackName - the name of the multiplexer stack

setMuxChannelFactory

public void setMuxChannelFactory(org.jgroups.ChannelFactory factory)

Specified by:

setMuxChannelFactory in interface LegacyConfiguration

setNodeLockingScheme

public void setNodeLockingScheme(java.lang.String nodeLockingScheme)

Specified by:

setNodeLockingScheme in interface LegacyConfiguration

setReplQueueInterval

public void setReplQueueInterval(long interval)

Specified by:

setReplQueueInterval in interface LegacyConfiguration

setReplQueueMaxElements

public void setReplQueueMaxElements(int max_elements)

Specified by:

setReplQueueMaxElements in interface LegacyConfiguration

setReplicationVersion

public void setReplicationVersion(java.lang.String version)

Description copied from interface: LegacyConfiguration

Sets the format version of the data transferred during an initial state transfer or a call to Region.activate(). Different releases of JBossCache may format this data differently; this property identifies the format version being used by this cache instance. Setting this property to a value other than the default allows a cache instance from a later release to interoperate with a cache instance from an earlier release.

Specified by:

setReplicationVersion in interface LegacyConfiguration

Parameters:

version - a short identifying JBossCache release; e.g. 124 for JBossCache 1.2.4

setSyncCommitPhase

public void setSyncCommitPhase(boolean sync_commit_phase)

Specified by:

setSyncCommitPhase in interface LegacyConfiguration

setSyncReplTimeout

public void setSyncReplTimeout(long timeout)

Description copied from interface: LegacyConfiguration

Sets the default maximum wait time for synchronous replication to receive all results

Specified by:

setSyncReplTimeout in interface LegacyConfiguration

setSyncRollbackPhase

public void setSyncRollbackPhase(boolean sync_rollback_phase)

Specified by:

setSyncRollbackPhase in interface LegacyConfiguration

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager manager)

Specified by:

setTransactionManager in interface LegacyConfiguration

setTransactionManagerLookupClass

public void setTransactionManagerLookupClass(java.lang.String cl)
                                      throws java.lang.Exception

Description copied from interface: LegacyConfiguration

Sets the class of the TransactionManagerLookup impl. This will attempt to create an instance, and will throw an exception if this fails.

Specified by:

setTransactionManagerLookupClass in interface LegacyConfiguration

Throws:

java.lang.Exception

setUseRegionBasedMarshalling

public void setUseRegionBasedMarshalling(boolean isTrue)

Description copied from interface: LegacyConfiguration

Sets whether marshalling uses scoped class loaders on a per region basis.

This property must be set to true before any call to Region.registerContextClassLoader(ClassLoader).

Specified by:

setUseRegionBasedMarshalling in interface LegacyConfiguration

setUseReplQueue

public void setUseReplQueue(boolean flag)

Specified by:

setUseReplQueue in interface LegacyConfiguration

create

public void create()
            throws CacheException

Specified by:

create in interface CacheJmxWrapperMBean<K,V>

Throws:

CacheException

start

public void start()
           throws CacheException

Specified by:

start in interface CacheJmxWrapperMBean<K,V>

Throws:

CacheException

stop

public void stop()

Specified by:

stop in interface CacheJmxWrapperMBean<K,V>

destroy

public void destroy()

Specified by:

destroy in interface CacheJmxWrapperMBean<K,V>

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName objName)
                                        throws java.lang.Exception

Caches the provided server and objName.

Specified by:

preRegister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

postRegister

public void postRegister(java.lang.Boolean registrationDone)

Registers the cache's interceptors, if getRegisterInterceptors() is true.

Specified by:

postRegister in interface javax.management.MBeanRegistration

preDeregister

public void preDeregister()
                   throws java.lang.Exception

No-op.

Specified by:

preDeregister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

postDeregister

public void postDeregister()

Unregisters the interceptors, if getRegisterInterceptors() is true.

Specified by:

postDeregister in interface javax.management.MBeanRegistration

setConfiguration

public void setConfiguration(Configuration config)

Sets the configuration that the underlying cache should use.

Parameters:

config - the configuration

Throws:

java.lang.IllegalArgumentException - if config is null.

setCache

public void setCache(Cache<K,V> cache)

Allows direct injection of the underlying cache.

Parameters:

cache -

getCacheObjectName

public java.lang.String getCacheObjectName()

setCacheObjectName

public void setCacheObjectName(java.lang.String name)
                        throws javax.management.MalformedObjectNameException

Throws:

javax.management.MalformedObjectNameException

isDisableStateChangeNotifications

public boolean isDisableStateChangeNotifications()

Gets whether sending of JMX notifications for this mbean's start/stop lifecycle changes is disabled.

See Also:

setDisableStateChangeNotifications(boolean)

setDisableStateChangeNotifications

public void setDisableStateChangeNotifications(boolean disableStateChangeNotifications)

Hook to allow PojoCacheJmxWrapper to suppress state change notifications from this mbean in lieu of its own.

Parameters:

disableStateChangeNotifications -

getMBeanServer

public javax.management.MBeanServer getMBeanServer()

formatHtml

public static java.lang.String formatHtml(java.lang.String s)

Formats a given String for display as an HTML snippet.

Parameters:

s - string to format

Returns:

formatted string

getNotificationServiceName

public java.lang.String getNotificationServiceName()

setNotificationServiceName

public void setNotificationServiceName(java.lang.String notificationServiceName)

getNextNotificationSequenceNumber

public long getNextNotificationSequenceNumber()

Description copied from interface: CacheNotificationBroadcaster

Gets the sequence number for the next notification.

Specified by:

getNextNotificationSequenceNumber in interface CacheNotificationBroadcaster

addNotificationListener

public void addNotificationListener(javax.management.NotificationListener notificationListener,
                                    javax.management.NotificationFilter notificationFilter,
                                    java.lang.Object object)
                             throws java.lang.IllegalArgumentException

Specified by:

addNotificationListener in interface javax.management.NotificationBroadcaster

Overrides:

addNotificationListener in class javax.management.NotificationBroadcasterSupport

Throws:

java.lang.IllegalArgumentException

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener notificationListener)
                                throws javax.management.ListenerNotFoundException

Specified by:

removeNotificationListener in interface javax.management.NotificationBroadcaster

Overrides:

removeNotificationListener in class javax.management.NotificationBroadcasterSupport

Throws:

javax.management.ListenerNotFoundException

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener listener,
                                       javax.management.NotificationFilter filter,
                                       java.lang.Object handback)
                                throws javax.management.ListenerNotFoundException

Specified by:

removeNotificationListener in interface javax.management.NotificationEmitter

Overrides:

removeNotificationListener in class javax.management.NotificationBroadcasterSupport

Throws:

javax.management.ListenerNotFoundException

getNotificationInfo

public javax.management.MBeanNotificationInfo[] getNotificationInfo()

Specified by:

getNotificationInfo in interface javax.management.NotificationBroadcaster

Overrides:

getNotificationInfo in class javax.management.NotificationBroadcasterSupport

constructCache

protected void constructCache()
                       throws ConfigurationException

Throws:

ConfigurationException

registerInterceptors

protected boolean registerInterceptors()
                                throws CacheException

Throws:

CacheException

unregisterInterceptors

protected void unregisterInterceptors()