org.jboss.cache.config
Class Configuration

java.lang.Object
  extended by org.jboss.cache.config.ConfigurationComponent
      extended by org.jboss.cache.config.Configuration
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class Configuration
extends ConfigurationComponent
implements java.lang.Cloneable

Encapsulates the configuration of a Cache.

Author:
Manik Surtani (manik@jboss.org)
See Also:
Serialized Form

Nested Class Summary
static class Configuration.CacheMode
          Cache replication mode.
static class Configuration.NodeLockingScheme
          Cache node locking scheme.
 
Field Summary
static short DEFAULT_REPLICATION_VERSION
          Default replication version, from Version.getVersionShort().
 
Fields inherited from class org.jboss.cache.config.ConfigurationComponent
log
 
Constructor Summary
Configuration()
          Default empty constructor
Configuration(CacheImpl cache)
          Sets a reference to an existing CacheImpl instance
 
Method Summary
 Configuration clone()
           
 boolean equals(java.lang.Object o)
           
 BuddyReplicationConfig getBuddyReplicationConfig()
           
 CacheLoaderConfig getCacheLoaderConfig()
           
 Configuration.CacheMode getCacheMode()
           
 java.lang.String getCacheModeString()
           
 java.lang.String getClusterConfig()
           
 java.lang.String getClusterName()
           
 EvictionConfig getEvictionConfig()
           
 boolean getExposeManagementStatistics()
           
 long getInitialStateRetrievalTimeout()
          Deprecated. 
 IsolationLevel getIsolationLevel()
           
 java.lang.String getIsolationLevelString()
           
 long getLockAcquisitionTimeout()
           
 java.lang.String getMarshallerClass()
           
 java.lang.String getMultiplexerStack()
           
 Configuration.NodeLockingScheme getNodeLockingScheme()
           
 java.lang.String getNodeLockingSchemeString()
           
 int getNumberOfNotifierThreads()
           
 short getReplicationVersion()
           
 long getReplQueueInterval()
           
 int getReplQueueMaxElements()
           
 java.lang.String getReplVersionString()
           
 RuntimeConfig getRuntimeConfig()
           
 long getStateRetrievalTimeout()
           
 long getSyncReplTimeout()
           
 java.lang.String getTransactionManagerLookupClass()
           
 int hashCode()
           
 boolean isFetchInMemoryState()
           
 boolean isInactiveOnStartup()
           
 boolean isLockParentForChildInsertRemove()
          Gets whether inserting or removing a node requires a write lock on the node's parent (when pessimistic locking is used.)

The default value is false

 boolean isNodeLockingOptimistic()
           
 boolean isSyncCommitPhase()
           
 boolean isSyncRollbackPhase()
           
 boolean isUseRegionBasedMarshalling()
           
 boolean isUseReplQueue()
           
 boolean isUsingMultiplexer()
           
static Configuration.CacheMode legacyModeToCacheMode(int legacyMode)
           
 void setBuddyReplicationConfig(BuddyReplicationConfig config)
           
 void setCacheLoaderConfig(CacheLoaderConfig config)
           
 void setCacheMode(Configuration.CacheMode cacheModeInt)
           
 void setCacheMode(java.lang.String cacheMode)
           
 void setCacheModeString(java.lang.String cacheMode)
           
 void setClusterConfig(org.w3c.dom.Element config)
          Converts a list of elements to a Java Groups property string.
 void setClusterConfig(java.lang.String clusterConfig)
           
 void setClusterName(java.lang.String clusterName)
           
 void setEvictionConfig(EvictionConfig config)
           
 void setExposeManagementStatistics(boolean useMbean)
           
 void setFetchInMemoryState(boolean fetchInMemoryState)
           
 void setInactiveOnStartup(boolean inactiveOnStartup)
           
 void setInitialStateRetrievalTimeout(long stateRetrievalTimeout)
          Deprecated. 
 void setIsolationLevel(IsolationLevel isolationLevel)
           
 void setIsolationLevel(java.lang.String isolationLevel)
           
 void setIsolationLevelString(java.lang.String isolationLevel)
           
 void setLockAcquisitionTimeout(long lockAcquisitionTimeout)
           
 void setLockParentForChildInsertRemove(boolean lockParentForChildInsertRemove)
          Sets whether inserting or removing a node requires a write lock on the node's parent (when pessimistic locking is used.)

The default value is false

 void setMarshallerClass(java.lang.String marshallerClass)
           
 void setMultiplexerStack(java.lang.String stackName)
           
 void setNodeLockingOptimistic(boolean nodeLockingOptimistic)
           
 void setNodeLockingScheme(Configuration.NodeLockingScheme nodeLockingScheme)
           
 void setNodeLockingScheme(java.lang.String nodeLockingScheme)
           
 void setNodeLockingSchemeString(java.lang.String nodeLockingScheme)
           
 void setNumberOfNotifierThreads(int numberOfNotifierThreads)
           
 void setReplicationVersion(short replicationVersion)
           
 void setReplQueueInterval(long replQueueInterval)
           
 void setReplQueueMaxElements(int replQueueMaxElements)
           
 void setReplVersionString(java.lang.String replVersionString)
           
 void setRuntimeConfig(RuntimeConfig runtimeConfig)
           
 void setStateRetrievalTimeout(long stateRetrievalTimeout)
           
 void setSyncCommitPhase(boolean syncCommitPhase)
           
 void setSyncReplTimeout(long syncReplTimeout)
           
 void setSyncRollbackPhase(boolean syncRollbackPhase)
           
 void setTransactionManagerLookupClass(java.lang.String transactionManagerLookupClass)
           
 void setUseRegionBasedMarshalling(boolean useRegionBasedMarshalling)
           
 void setUseReplQueue(boolean useReplQueue)
           
 void setUsingMultiplexer(boolean usingMultiplexer)
           
 
Methods inherited from class org.jboss.cache.config.ConfigurationComponent
addChildConfig, addChildConfigs, getTreeCache, passCacheToChildConfig, removeChildConfig, removeChildConfigs, replaceChildConfig, replaceChildConfigs, safeEquals, setCacheImpl, testImmutability
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_REPLICATION_VERSION

public static final short DEFAULT_REPLICATION_VERSION
Default replication version, from Version.getVersionShort().

Constructor Detail

Configuration

public Configuration(CacheImpl cache)
Sets a reference to an existing CacheImpl instance

Parameters:
cache -

Configuration

public Configuration()
Default empty constructor

Method Detail

legacyModeToCacheMode

public static Configuration.CacheMode legacyModeToCacheMode(int legacyMode)

setClusterConfig

public void setClusterConfig(org.w3c.dom.Element config)
Converts a list of elements to a Java Groups property string.


setClusterName

public void setClusterName(java.lang.String clusterName)

setClusterConfig

public void setClusterConfig(java.lang.String clusterConfig)

setReplQueueMaxElements

public void setReplQueueMaxElements(int replQueueMaxElements)

setReplQueueInterval

public void setReplQueueInterval(long replQueueInterval)

setExposeManagementStatistics

public void setExposeManagementStatistics(boolean useMbean)

setFetchInMemoryState

public void setFetchInMemoryState(boolean fetchInMemoryState)

setReplicationVersion

public void setReplicationVersion(short replicationVersion)

setReplVersionString

public void setReplVersionString(java.lang.String replVersionString)

setLockAcquisitionTimeout

public void setLockAcquisitionTimeout(long lockAcquisitionTimeout)

setSyncReplTimeout

public void setSyncReplTimeout(long syncReplTimeout)

setCacheMode

public void setCacheMode(Configuration.CacheMode cacheModeInt)

setCacheMode

public void setCacheMode(java.lang.String cacheMode)

getCacheModeString

public java.lang.String getCacheModeString()

setCacheModeString

public void setCacheModeString(java.lang.String cacheMode)

setInactiveOnStartup

public void setInactiveOnStartup(boolean inactiveOnStartup)

getEvictionConfig

public EvictionConfig getEvictionConfig()

setEvictionConfig

public void setEvictionConfig(EvictionConfig config)

setUseRegionBasedMarshalling

public void setUseRegionBasedMarshalling(boolean useRegionBasedMarshalling)

setTransactionManagerLookupClass

public void setTransactionManagerLookupClass(java.lang.String transactionManagerLookupClass)

setCacheLoaderConfig

public void setCacheLoaderConfig(CacheLoaderConfig config)

setSyncCommitPhase

public void setSyncCommitPhase(boolean syncCommitPhase)

setSyncRollbackPhase

public void setSyncRollbackPhase(boolean syncRollbackPhase)

setBuddyReplicationConfig

public void setBuddyReplicationConfig(BuddyReplicationConfig config)

setNodeLockingScheme

public void setNodeLockingScheme(Configuration.NodeLockingScheme nodeLockingScheme)

setUseReplQueue

public void setUseReplQueue(boolean useReplQueue)

setIsolationLevel

public void setIsolationLevel(IsolationLevel isolationLevel)

setNodeLockingOptimistic

public void setNodeLockingOptimistic(boolean nodeLockingOptimistic)

setInitialStateRetrievalTimeout

@Deprecated
public void setInitialStateRetrievalTimeout(long stateRetrievalTimeout)
Deprecated. 


setStateRetrievalTimeout

public void setStateRetrievalTimeout(long stateRetrievalTimeout)

setNodeLockingScheme

public void setNodeLockingScheme(java.lang.String nodeLockingScheme)

getNodeLockingSchemeString

public java.lang.String getNodeLockingSchemeString()

setNodeLockingSchemeString

public void setNodeLockingSchemeString(java.lang.String nodeLockingScheme)

setIsolationLevel

public void setIsolationLevel(java.lang.String isolationLevel)

getIsolationLevelString

public java.lang.String getIsolationLevelString()

setIsolationLevelString

public void setIsolationLevelString(java.lang.String isolationLevel)

setLockParentForChildInsertRemove

public void setLockParentForChildInsertRemove(boolean lockParentForChildInsertRemove)
Sets whether inserting or removing a node requires a write lock on the node's parent (when pessimistic locking is used.)

The default value is false


setMultiplexerStack

public void setMultiplexerStack(java.lang.String stackName)

isUsingMultiplexer

public boolean isUsingMultiplexer()

setUsingMultiplexer

public void setUsingMultiplexer(boolean usingMultiplexer)

isNodeLockingOptimistic

public boolean isNodeLockingOptimistic()

isUseReplQueue

public boolean isUseReplQueue()

getClusterName

public java.lang.String getClusterName()

getClusterConfig

public java.lang.String getClusterConfig()

getReplQueueMaxElements

public int getReplQueueMaxElements()

getReplQueueInterval

public long getReplQueueInterval()

getExposeManagementStatistics

public boolean getExposeManagementStatistics()

isFetchInMemoryState

public boolean isFetchInMemoryState()

getReplicationVersion

public short getReplicationVersion()

getReplVersionString

public java.lang.String getReplVersionString()

getLockAcquisitionTimeout

public long getLockAcquisitionTimeout()

getSyncReplTimeout

public long getSyncReplTimeout()

getCacheMode

public Configuration.CacheMode getCacheMode()

isInactiveOnStartup

public boolean isInactiveOnStartup()

getIsolationLevel

public IsolationLevel getIsolationLevel()

isLockParentForChildInsertRemove

public boolean isLockParentForChildInsertRemove()
Gets whether inserting or removing a node requires a write lock on the node's parent (when pessimistic locking is used.)

The default value is false


isUseRegionBasedMarshalling

public boolean isUseRegionBasedMarshalling()

getTransactionManagerLookupClass

public java.lang.String getTransactionManagerLookupClass()

getCacheLoaderConfig

public CacheLoaderConfig getCacheLoaderConfig()

isSyncCommitPhase

public boolean isSyncCommitPhase()

isSyncRollbackPhase

public boolean isSyncRollbackPhase()

getBuddyReplicationConfig

public BuddyReplicationConfig getBuddyReplicationConfig()

getNodeLockingScheme

public Configuration.NodeLockingScheme getNodeLockingScheme()

getInitialStateRetrievalTimeout

@Deprecated
public long getInitialStateRetrievalTimeout()
Deprecated. 


getStateRetrievalTimeout

public long getStateRetrievalTimeout()

getMultiplexerStack

public java.lang.String getMultiplexerStack()

getRuntimeConfig

public RuntimeConfig getRuntimeConfig()

setRuntimeConfig

public void setRuntimeConfig(RuntimeConfig runtimeConfig)

getMarshallerClass

public java.lang.String getMarshallerClass()

setMarshallerClass

public void setMarshallerClass(java.lang.String marshallerClass)

getNumberOfNotifierThreads

public int getNumberOfNotifierThreads()

setNumberOfNotifierThreads

public void setNumberOfNotifierThreads(int numberOfNotifierThreads)

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

clone

public Configuration clone()
                    throws java.lang.CloneNotSupportedException
Overrides:
clone in class ConfigurationComponent
Throws:
java.lang.CloneNotSupportedException