|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.cache.pojo.jmx.PojoCacheJmxWrapper
public class PojoCacheJmxWrapper
Field Summary |
---|
Fields inherited from interface org.jboss.cache.pojo.jmx.PojoCacheJmxWrapperMBean |
---|
CREATED, DESTROYED, FAILED, REGISTERED, STARTED, STARTING, STOPPED, STOPPING, UNREGISTERED |
Constructor Summary | |
---|---|
PojoCacheJmxWrapper()
Default constructor. |
|
PojoCacheJmxWrapper(PojoCache toWrap)
Creates a PojoCacheJmxWrapper that wraps the given PojoCache. |
Method Summary | |
---|---|
void |
addNotificationListener(javax.management.NotificationListener listener,
javax.management.NotificationFilter filter,
java.lang.Object handback)
|
void |
create()
Lifecycle method to start PojoCache. |
void |
destroy()
Lifecycle method to destroy PojoCache. |
org.w3c.dom.Element |
getBuddyReplicationConfig()
Retrieves the buddy replication configuration element |
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. |
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()
Retrieves an immutable configuration. |
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 |
getInternalLocation(java.lang.Object pojo)
Obtain the internal location of this pojo stored under PojoCache. |
java.lang.String |
getIsolationLevel()
Returns the transaction isolation level. |
long |
getLockAcquisitionTimeout()
Default max time to wait for a lock. |
javax.management.MBeanServer |
getMBeanServer()
|
org.jgroups.jmx.JChannelFactoryMBean |
getMultiplexerService()
|
java.lang.String |
getMultiplexerStack()
Retrieves the JGroups multiplexer stack name if defined. |
org.jgroups.ChannelFactory |
getMuxChannelFactory()
|
java.lang.String |
getNodeLockingScheme()
|
javax.management.MBeanNotificationInfo[] |
getNotificationInfo()
|
PojoCache |
getPojoCache()
Returns the PojoCache. |
boolean |
getRegisterInterceptors()
Gets whether this object should register the cache's interceptors with JMX. |
boolean |
getRegisterPlainCache()
Gets whether this object should register a CacheJmxWrapperMBean
for the underlying Cache with JMX. |
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()
|
java.lang.String |
getUnderlyingCacheObjectName()
Get the MBean object name that the underlying replicated cache is using. |
boolean |
getUseInterceptorMbeans()
|
boolean |
getUseRegionBasedMarshalling()
Gets whether marshalling uses scoped class loaders on a per region basis. |
boolean |
getUseReplQueue()
|
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 CacheJmxWrapper, if getRegisterPlainCache() is
true . |
void |
postRegister(java.lang.Boolean registrationDone)
Registers the CacheJmxWrapperMBean, if getRegisterPlainCache() is true . |
void |
preDeregister()
No-op. |
javax.management.ObjectName |
preRegister(javax.management.MBeanServer server,
javax.management.ObjectName objName)
Caches the provided server and objName . |
void |
removeNotificationListener(javax.management.NotificationListener listener)
|
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 |
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 |
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 |
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 |
setPojoCache(PojoCache cache)
|
void |
setRegisterInterceptors(boolean register)
Sets whether this object should register the cache's interceptors with JMX. |
void |
setRegisterPlainCache(boolean registerPlainCache)
Sets whether this object should register a CacheJmxWrapperMBean
for the underlying Cache with JMX. |
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()
Lifecycle method to start PojoCache. |
void |
stop()
Lifecycle method to stop PojoCache. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PojoCacheJmxWrapper()
public PojoCacheJmxWrapper(PojoCache toWrap)
toWrap
- the cacheMethod Detail |
---|
public PojoCache getPojoCache()
PojoCacheJmxWrapperMBean
getPojoCache
in interface PojoCacheJmxWrapperMBean
public Configuration getConfiguration()
PojoCacheJmxWrapperMBean
getConfiguration
in interface PojoCacheJmxWrapperMBean
public java.lang.String getInternalLocation(java.lang.Object pojo) throws PojoCacheAlreadyDetachedException
PojoCacheJmxWrapperMBean
getInternalLocation
in interface PojoCacheJmxWrapperMBean
pojo
- That is associated with this POJO. If null, it means all POJOs in this cache system.
PojoCacheAlreadyDetachedException
- if pojo has been detached already.public java.lang.String getUnderlyingCacheObjectName()
PojoCacheJmxWrapperMBean
getUnderlyingCacheObjectName
in interface PojoCacheJmxWrapperMBean
public void create() throws PojoCacheException
PojoCacheJmxWrapperMBean
create
in interface PojoCacheJmxWrapperMBean
PojoCacheException
public void start() throws PojoCacheException
PojoCacheJmxWrapperMBean
start
in interface PojoCacheJmxWrapperMBean
PojoCacheException
public void stop()
PojoCacheJmxWrapperMBean
stop
in interface PojoCacheJmxWrapperMBean
public void destroy()
PojoCacheJmxWrapperMBean
destroy
in interface PojoCacheJmxWrapperMBean
public CacheStatus getCacheStatus()
PojoCacheJmxWrapperMBean
getCacheStatus
in interface PojoCacheJmxWrapperMBean
null
public int getState()
PojoCacheJmxWrapperMBean
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.
getState
in interface PojoCacheJmxWrapperMBean
PojoCacheJmxWrapperMBean.STARTED
.public boolean getRegisterPlainCache()
PojoCacheJmxWrapperMBean
CacheJmxWrapperMBean
for the underlying Cache
with JMX.
Default is true
.
getRegisterPlainCache
in interface PojoCacheJmxWrapperMBean
public void setRegisterPlainCache(boolean registerPlainCache)
PojoCacheJmxWrapperMBean
CacheJmxWrapperMBean
for the underlying Cache
with JMX.
Default is true
.
If true
, the CacheJmxWrapperMBean
will be
instantiated and registered either as part of the registration of
this object, or during the call to PojoCacheJmxWrapperMBean.create()
.
setRegisterPlainCache
in interface PojoCacheJmxWrapperMBean
public boolean getRegisterInterceptors()
PojoCacheJmxWrapperMBean
registerPlainCache
is true
.
Default is true
.
getRegisterInterceptors
in interface PojoCacheJmxWrapperMBean
public void setRegisterInterceptors(boolean register)
PojoCacheJmxWrapperMBean
registerPlainCache
is true
.
Default is true
.
setRegisterInterceptors
in interface PojoCacheJmxWrapperMBean
public org.w3c.dom.Element getBuddyReplicationConfig()
LegacyConfiguration
getBuddyReplicationConfig
in interface LegacyConfiguration
LegacyConfiguration.setBuddyReplicationConfig(Element)
or null
if nothing waspublic org.w3c.dom.Element getCacheLoaderConfig()
LegacyConfiguration
getCacheLoaderConfig
in interface LegacyConfiguration
LegacyConfiguration.setCacheLoaderConfig(Element)
or null
if nothing waspublic org.w3c.dom.Element getCacheLoaderConfiguration()
getCacheLoaderConfiguration
in interface LegacyConfiguration
public java.lang.String getCacheMode()
LegacyConfiguration
getCacheMode
in interface LegacyConfiguration
public java.lang.String getClusterName()
LegacyConfiguration
getClusterName
in interface LegacyConfiguration
public java.lang.String getClusterProperties()
LegacyConfiguration
getClusterProperties
in interface LegacyConfiguration
public org.w3c.dom.Element getClusterConfig()
LegacyConfiguration
getClusterConfig
in interface LegacyConfiguration
null
if it was not
set via LegacyConfiguration.setClusterConfig(Element)
public org.w3c.dom.Element getEvictionPolicyConfig()
getEvictionPolicyConfig
in interface LegacyConfiguration
LegacyConfiguration.setEvictionPolicyConfig(Element)
or null
if nothing waspublic boolean getExposeManagementStatistics()
LegacyConfiguration
getExposeManagementStatistics
in interface LegacyConfiguration
public boolean getUseInterceptorMbeans()
getUseInterceptorMbeans
in interface LegacyConfiguration
public boolean getFetchInMemoryState()
LegacyConfiguration
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.
getFetchInMemoryState
in interface LegacyConfiguration
public long getStateRetrievalTimeout()
LegacyConfiguration
getStateRetrievalTimeout
in interface LegacyConfiguration
@Deprecated public void setInitialStateRetrievalTimeout(long timeout)
LegacyConfiguration
LegacyConfiguration.getInitialStateRetrievalTimeout()
)
setInitialStateRetrievalTimeout
in interface LegacyConfiguration
public java.lang.String getIsolationLevel()
LegacyConfiguration
getIsolationLevel
in interface LegacyConfiguration
public long getLockAcquisitionTimeout()
LegacyConfiguration
getLockAcquisitionTimeout
in interface LegacyConfiguration
public org.jgroups.jmx.JChannelFactoryMBean getMultiplexerService()
getMultiplexerService
in interface LegacyConfiguration
public java.lang.String getMultiplexerStack()
LegacyConfiguration
getMultiplexerStack
in interface LegacyConfiguration
public org.jgroups.ChannelFactory getMuxChannelFactory()
getMuxChannelFactory
in interface LegacyConfiguration
public java.lang.String getNodeLockingScheme()
getNodeLockingScheme
in interface LegacyConfiguration
public long getReplQueueInterval()
getReplQueueInterval
in interface LegacyConfiguration
public int getReplQueueMaxElements()
getReplQueueMaxElements
in interface LegacyConfiguration
public java.lang.String getReplicationVersion()
LegacyConfiguration
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
.
getReplicationVersion
in interface LegacyConfiguration
124
for JBossCache 1.2.4public boolean getSyncCommitPhase()
getSyncCommitPhase
in interface LegacyConfiguration
public long getSyncReplTimeout()
LegacyConfiguration
getSyncReplTimeout
in interface LegacyConfiguration
public boolean getSyncRollbackPhase()
getSyncRollbackPhase
in interface LegacyConfiguration
public javax.transaction.TransactionManager getTransactionManager()
getTransactionManager
in interface LegacyConfiguration
public java.lang.String getTransactionManagerLookupClass()
getTransactionManagerLookupClass
in interface LegacyConfiguration
public boolean getUseRegionBasedMarshalling()
LegacyConfiguration
getUseRegionBasedMarshalling
in interface LegacyConfiguration
public boolean getUseReplQueue()
getUseReplQueue
in interface LegacyConfiguration
public boolean isInactiveOnStartup()
LegacyConfiguration
Configuration.isUseRegionBasedMarshalling()
is
true
.
isInactiveOnStartup
in interface LegacyConfiguration
public void setBuddyReplicationConfig(org.w3c.dom.Element config)
LegacyConfiguration
setBuddyReplicationConfig
in interface LegacyConfiguration
public void setCacheLoaderConfig(org.w3c.dom.Element cache_loader_config)
setCacheLoaderConfig
in interface LegacyConfiguration
public void setCacheLoaderConfiguration(org.w3c.dom.Element config)
setCacheLoaderConfiguration
in interface LegacyConfiguration
public void setCacheMode(java.lang.String mode) throws java.lang.Exception
LegacyConfiguration
setCacheMode
in interface LegacyConfiguration
java.lang.Exception
public void setClusterConfig(org.w3c.dom.Element config)
LegacyConfiguration
setClusterConfig
in interface LegacyConfiguration
@Deprecated public long getInitialStateRetrievalTimeout()
LegacyConfiguration
getInitialStateRetrievalTimeout
in interface LegacyConfiguration
public void setClusterName(java.lang.String name)
LegacyConfiguration
setClusterName
in interface LegacyConfiguration
public void setClusterProperties(java.lang.String cluster_props)
LegacyConfiguration
setClusterProperties
in interface LegacyConfiguration
cluster_props
- The properties for the cluster (JGroups)public void setEvictionPolicyConfig(org.w3c.dom.Element config)
LegacyConfiguration
setEvictionPolicyConfig
in interface LegacyConfiguration
public void setExposeManagementStatistics(boolean expose)
setExposeManagementStatistics
in interface LegacyConfiguration
public void setUseInterceptorMbeans(boolean use)
setUseInterceptorMbeans
in interface LegacyConfiguration
public void setFetchInMemoryState(boolean flag)
LegacyConfiguration
setFetchInMemoryState
in interface LegacyConfiguration
public void setInactiveOnStartup(boolean inactiveOnStartup)
LegacyConfiguration
Region.activate()
is
called to activate one or more parts of the tree.
This property is only relevant if Configuration.isUseRegionBasedMarshalling()
is
true
.
setInactiveOnStartup
in interface LegacyConfiguration
public void setStateRetrievalTimeout(long timeout)
LegacyConfiguration
LegacyConfiguration.getStateRetrievalTimeout()
)
setStateRetrievalTimeout
in interface LegacyConfiguration
public void setIsolationLevel(java.lang.String level)
LegacyConfiguration
setIsolationLevel
in interface LegacyConfiguration
public void setLockAcquisitionTimeout(long timeout)
LegacyConfiguration
setLockAcquisitionTimeout
in interface LegacyConfiguration
public void setMultiplexerService(org.jgroups.jmx.JChannelFactoryMBean muxService)
setMultiplexerService
in interface LegacyConfiguration
public void setMultiplexerStack(java.lang.String stackName)
LegacyConfiguration
setMultiplexerStack
in interface LegacyConfiguration
stackName
- the name of the multiplexer stackpublic void setMuxChannelFactory(org.jgroups.ChannelFactory factory)
setMuxChannelFactory
in interface LegacyConfiguration
public void setNodeLockingScheme(java.lang.String nodeLockingScheme)
setNodeLockingScheme
in interface LegacyConfiguration
public void setReplQueueInterval(long interval)
setReplQueueInterval
in interface LegacyConfiguration
public void setReplQueueMaxElements(int max_elements)
setReplQueueMaxElements
in interface LegacyConfiguration
public void setReplicationVersion(java.lang.String version)
LegacyConfiguration
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.
setReplicationVersion
in interface LegacyConfiguration
version
- a short identifying JBossCache release;
e.g. 124
for JBossCache 1.2.4public void setSyncCommitPhase(boolean sync_commit_phase)
setSyncCommitPhase
in interface LegacyConfiguration
public void setSyncReplTimeout(long timeout)
LegacyConfiguration
setSyncReplTimeout
in interface LegacyConfiguration
public void setSyncRollbackPhase(boolean sync_rollback_phase)
setSyncRollbackPhase
in interface LegacyConfiguration
public void setTransactionManager(javax.transaction.TransactionManager manager)
setTransactionManager
in interface LegacyConfiguration
public void setTransactionManagerLookupClass(java.lang.String cl) throws java.lang.Exception
LegacyConfiguration
setTransactionManagerLookupClass
in interface LegacyConfiguration
java.lang.Exception
public void setUseRegionBasedMarshalling(boolean isTrue)
LegacyConfiguration
true
before any call to
Region.registerContextClassLoader(ClassLoader)
.
setUseRegionBasedMarshalling
in interface LegacyConfiguration
public void setUseReplQueue(boolean flag)
setUseReplQueue
in interface LegacyConfiguration
public javax.management.ObjectName preRegister(javax.management.MBeanServer server, javax.management.ObjectName objName) throws java.lang.Exception
server
and objName
.
preRegister
in interface javax.management.MBeanRegistration
java.lang.Exception
public void postRegister(java.lang.Boolean registrationDone)
getRegisterPlainCache()
is true
.
postRegister
in interface javax.management.MBeanRegistration
public void preDeregister() throws java.lang.Exception
preDeregister
in interface javax.management.MBeanRegistration
java.lang.Exception
public void postDeregister()
getRegisterPlainCache()
is
true
.
postDeregister
in interface javax.management.MBeanRegistration
public void removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback) throws javax.management.ListenerNotFoundException
removeNotificationListener
in interface javax.management.NotificationEmitter
javax.management.ListenerNotFoundException
public void addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback) throws java.lang.IllegalArgumentException
addNotificationListener
in interface javax.management.NotificationBroadcaster
java.lang.IllegalArgumentException
public javax.management.MBeanNotificationInfo[] getNotificationInfo()
getNotificationInfo
in interface javax.management.NotificationBroadcaster
public void removeNotificationListener(javax.management.NotificationListener listener) throws javax.management.ListenerNotFoundException
removeNotificationListener
in interface javax.management.NotificationBroadcaster
javax.management.ListenerNotFoundException
public javax.management.MBeanServer getMBeanServer()
public void setConfiguration(Configuration config)
config
- the configurationpublic void setPojoCache(PojoCache cache)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |