org.jboss.cache.jmx
Interface LegacyConfiguration

All Known Subinterfaces:

CacheJmxWrapperMBean<K,V>

All Known Implementing Classes:

CacheJmxWrapper

Deprecated. use JmxRegistrationManager

@Deprecated
public interface LegacyConfiguration

Legacy configuration attributes from JBC 1.x.

Version:

$Revision: 6776 $

Author:

Brian Stansberry

Method Summary

Element	getBuddyReplicationConfig() Deprecated. Retrieves the buddy replication configuration element
Element	getCacheLoaderConfig() Deprecated. Retrieves the cache loader configuration element
Element	getCacheLoaderConfiguration() Deprecated. use getCacheLoaderConfig()
String	getCacheMode() Deprecated. Returns the current caching mode.
Element	getClusterConfig() Deprecated. Gets the JGroups protocol stack config in W3C DOM Element form.
String	getClusterName() Deprecated. Get the name of the replication group
String	getClusterProperties() Deprecated. Get the cluster properties (e.g. the protocol stack specification in case of JGroups)
Element	getEvictionPolicyConfig() Deprecated.
boolean	getExposeManagementStatistics() Deprecated. Gets whether the cache should create interceptor mbeans that are used to capture and publish interceptor statistics.
boolean	getFetchInMemoryState() Deprecated. 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. use getStateRetrievalTimeout()
String	getIsolationLevel() Deprecated. Returns the transaction isolation level.
long	getLockAcquisitionTimeout() Deprecated. Default max time to wait for a lock.
org.jgroups.jmx.JChannelFactoryMBean	getMultiplexerService() Deprecated.
String	getMultiplexerStack() Deprecated. Retrieves the JGroups multiplexer stack name if defined.
org.jgroups.ChannelFactory	getMuxChannelFactory() Deprecated.
String	getNodeLockingScheme() Deprecated.
String	getReplicationVersion() Deprecated. Gets the format version of the data transferred during an initial state transfer or a call to Region.activate().
long	getReplQueueInterval() Deprecated.
int	getReplQueueMaxElements() Deprecated.
long	getStateRetrievalTimeout() Deprecated. Get the max time to wait until the state is retrieved.
boolean	getSyncCommitPhase() Deprecated.
long	getSyncReplTimeout() Deprecated. Returns the default max timeout after which synchronous replication calls return.
boolean	getSyncRollbackPhase() Deprecated.
TransactionManager	getTransactionManager() Deprecated.
String	getTransactionManagerLookupClass() Deprecated.
boolean	getUseInterceptorMbeans() Deprecated. use getExposeManagementStatistics()
boolean	getUseRegionBasedMarshalling() Deprecated. Gets whether marshalling uses scoped class loaders on a per region basis.
boolean	getUseReplQueue() Deprecated.
boolean	isInactiveOnStartup() Deprecated. 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	setBuddyReplicationConfig(Element config) Deprecated. Sets the buddy replication configuration element
void	setCacheLoaderConfig(Element cacheLoaderConfig) Deprecated.
void	setCacheLoaderConfiguration(Element cache_loader_config) Deprecated. use setCacheLoaderConfig(org.w3c.dom.Element)
void	setCacheMode(String mode) Deprecated. Sets the default caching mode)
void	setClusterConfig(Element config) Deprecated. Convert a list of elements to the JG property string
void	setClusterName(String name) Deprecated. Set the name of the replication group
void	setClusterProperties(String cluster_props) Deprecated. Set the cluster properties.
void	setEvictionPolicyConfig(Element config) Deprecated. Setup eviction policy configuration
void	setExposeManagementStatistics(boolean expose) Deprecated.
void	setFetchInMemoryState(boolean flag) Deprecated. Sets whether or not any initial or subsequent partial state transfer should include in-memory state.
void	setInactiveOnStartup(boolean inactiveOnStartup) Deprecated. 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. use setStateRetrievalTimeout(long)
void	setIsolationLevel(String level) Deprecated. Set the transaction isolation level.
void	setLockAcquisitionTimeout(long timeout) Deprecated. Set the max time for lock acquisition.
void	setMultiplexerService(org.jgroups.jmx.JChannelFactoryMBean muxService) Deprecated.
void	setMultiplexerStack(String stackName) Deprecated. 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) Deprecated.
void	setNodeLockingScheme(String nodeLockingScheme) Deprecated.
void	setReplicationVersion(String version) Deprecated. Sets the format version of the data transferred during an initial state transfer or a call to Region.activate().
void	setReplQueueInterval(long interval) Deprecated.
void	setReplQueueMaxElements(int max_elements) Deprecated.
void	setStateRetrievalTimeout(long timeout) Deprecated. Set the state transfer timeout (see getStateRetrievalTimeout())
void	setSyncCommitPhase(boolean sync_commit_phase) Deprecated.
void	setSyncReplTimeout(long timeout) Deprecated. Sets the default maximum wait time for synchronous replication to receive all results
void	setSyncRollbackPhase(boolean sync_rollback_phase) Deprecated.
void	setTransactionManager(TransactionManager manager) Deprecated.
void	setTransactionManagerLookupClass(String cl) Deprecated. Sets the class of the TransactionManagerLookup impl.
void	setUseInterceptorMbeans(boolean expose) Deprecated. use setExposeManagementStatistics(boolean)
void	setUseRegionBasedMarshalling(boolean isTrue) Deprecated. Sets whether marshalling uses scoped class loaders on a per region basis.
void	setUseReplQueue(boolean flag) Deprecated.

Method Detail

getClusterName

String getClusterName()

Deprecated.

Get the name of the replication group

setClusterName

void setClusterName(String name)

Deprecated.

Set the name of the replication group

setUseRegionBasedMarshalling

void setUseRegionBasedMarshalling(boolean isTrue)

Deprecated.

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).

Parameters:

isTrue -

getUseRegionBasedMarshalling

boolean getUseRegionBasedMarshalling()

Deprecated.

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

Returns:

true if region based marshalling is used.

getExposeManagementStatistics

boolean getExposeManagementStatistics()

Deprecated.

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

Returns:

true if mbeans should be created for each interceptor

setExposeManagementStatistics

void setExposeManagementStatistics(boolean expose)

Deprecated.

getUseInterceptorMbeans

@Deprecated
boolean getUseInterceptorMbeans()

Deprecated. use getExposeManagementStatistics()

setUseInterceptorMbeans

@Deprecated
void setUseInterceptorMbeans(boolean expose)

Deprecated. use setExposeManagementStatistics(boolean)

getClusterProperties

String getClusterProperties()

Deprecated.

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

setClusterProperties

void setClusterProperties(String cluster_props)

Deprecated.

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

Parameters:

cluster_props - The properties for the cluster (JGroups)

getCacheLoaderConfig

Element getCacheLoaderConfig()

Deprecated.

Retrieves the cache loader configuration element

Returns:

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

setCacheLoaderConfig

void setCacheLoaderConfig(Element cacheLoaderConfig)

Deprecated.

getCacheLoaderConfiguration

@Deprecated
Element getCacheLoaderConfiguration()

Deprecated. use getCacheLoaderConfig()

setCacheLoaderConfiguration

@Deprecated
void setCacheLoaderConfiguration(Element cache_loader_config)

Deprecated. use setCacheLoaderConfig(org.w3c.dom.Element)

getSyncCommitPhase

boolean getSyncCommitPhase()

Deprecated.

setSyncCommitPhase

void setSyncCommitPhase(boolean sync_commit_phase)

Deprecated.

getSyncRollbackPhase

boolean getSyncRollbackPhase()

Deprecated.

setSyncRollbackPhase

void setSyncRollbackPhase(boolean sync_rollback_phase)

Deprecated.

getEvictionPolicyConfig

Element getEvictionPolicyConfig()

Deprecated.

Returns:

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

setEvictionPolicyConfig

void setEvictionPolicyConfig(Element config)

Deprecated.

Setup eviction policy configuration

getClusterConfig

Element getClusterConfig()

Deprecated.

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

Returns:

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

setClusterConfig

void setClusterConfig(Element config)

Deprecated.

Convert a list of elements to the JG property string

getInitialStateRetrievalTimeout

@Deprecated
long getInitialStateRetrievalTimeout()

Deprecated. use getStateRetrievalTimeout()

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.

Returns:

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

getStateRetrievalTimeout

long getStateRetrievalTimeout()

Deprecated.

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.

Returns:

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

setInitialStateRetrievalTimeout

@Deprecated
void setInitialStateRetrievalTimeout(long timeout)

Deprecated. use setStateRetrievalTimeout(long)

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

setStateRetrievalTimeout

void setStateRetrievalTimeout(long timeout)

Deprecated.

Set the state transfer timeout (see getStateRetrievalTimeout())

getCacheMode

String getCacheMode()

Deprecated.

Returns the current caching mode. Valid values are

• LOCAL
• REPL_ASYNC
• REPL_SYNC

  Returns:

  String The caching mode

setCacheMode

void setCacheMode(String mode)
                  throws Exception

Deprecated.

Sets the default caching mode)

Throws:

Exception

getSyncReplTimeout

long getSyncReplTimeout()

Deprecated.

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

Returns:

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

setSyncReplTimeout

void setSyncReplTimeout(long timeout)

Deprecated.

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

getUseReplQueue

boolean getUseReplQueue()

Deprecated.

setUseReplQueue

void setUseReplQueue(boolean flag)

Deprecated.

getReplQueueInterval

long getReplQueueInterval()

Deprecated.

setReplQueueInterval

void setReplQueueInterval(long interval)

Deprecated.

getReplQueueMaxElements

int getReplQueueMaxElements()

Deprecated.

setReplQueueMaxElements

void setReplQueueMaxElements(int max_elements)

Deprecated.

getIsolationLevel

String getIsolationLevel()

Deprecated.

Returns the transaction isolation level.

setIsolationLevel

void setIsolationLevel(String level)

Deprecated.

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

getFetchInMemoryState

boolean getFetchInMemoryState()

Deprecated.

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.

setFetchInMemoryState

void setFetchInMemoryState(boolean flag)

Deprecated.

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

getReplicationVersion

String getReplicationVersion()

Deprecated.

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.

Returns:

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

setReplicationVersion

void setReplicationVersion(String version)

Deprecated.

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.

Parameters:

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

getLockAcquisitionTimeout

long getLockAcquisitionTimeout()

Deprecated.

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

Returns:

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

setLockAcquisitionTimeout

void setLockAcquisitionTimeout(long timeout)

Deprecated.

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.

Parameters:

timeout -

getTransactionManagerLookupClass

String getTransactionManagerLookupClass()

Deprecated.

setTransactionManagerLookupClass

void setTransactionManagerLookupClass(String cl)
                                      throws Exception

Deprecated.

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

Parameters:

cl -

Throws:

Exception

getTransactionManager

TransactionManager getTransactionManager()

Deprecated.

setTransactionManager

void setTransactionManager(TransactionManager manager)

Deprecated.

setNodeLockingScheme

void setNodeLockingScheme(String nodeLockingScheme)

Deprecated.

getNodeLockingScheme

String getNodeLockingScheme()

Deprecated.

isInactiveOnStartup

boolean isInactiveOnStartup()

Deprecated.

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.

setInactiveOnStartup

void setInactiveOnStartup(boolean inactiveOnStartup)

Deprecated.

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.

setBuddyReplicationConfig

void setBuddyReplicationConfig(Element config)

Deprecated.

Sets the buddy replication configuration element

Parameters:

config -

getBuddyReplicationConfig

Element getBuddyReplicationConfig()

Deprecated.

Retrieves the buddy replication configuration element

Returns:

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

getMultiplexerStack

String getMultiplexerStack()

Deprecated.

Retrieves the JGroups multiplexer stack name if defined.

Returns:

the multiplexer stack name

setMultiplexerStack

void setMultiplexerStack(String stackName)

Deprecated.

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.

Parameters:

stackName - the name of the multiplexer stack

getMuxChannelFactory

org.jgroups.ChannelFactory getMuxChannelFactory()

Deprecated.

setMuxChannelFactory

void setMuxChannelFactory(org.jgroups.ChannelFactory factory)

Deprecated.

getMultiplexerService

org.jgroups.jmx.JChannelFactoryMBean getMultiplexerService()

Deprecated.

setMultiplexerService

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

Deprecated.