|
ehcache | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.ehcache.config.Configuration
public final class Configuration
A bean, used by BeanUtils, to set configuration from an XML configuration file.
| Nested Class Summary | |
|---|---|
static class |
Configuration.Monitoring
Represents whether monitoring should be enabled or not. |
| Field Summary | |
|---|---|
static boolean |
DEFAULT_DYNAMIC_CONFIG
Default value for dynamicConfig |
static Configuration.Monitoring |
DEFAULT_MONITORING
Default value for monitoring |
static FactoryConfiguration |
DEFAULT_TRANSACTION_MANAGER_LOOKUP_CONFIG
Default transactionManagerLookupConfiguration |
static int |
DEFAULT_TRANSACTION_TIMEOUT
Default value for defaultTransactionTimeoutInSeconds |
static boolean |
DEFAULT_UPDATE_CHECK
Default value for updateCheck |
| Constructor Summary | |
|---|---|
Configuration()
Empty constructor, which is used by ConfigurationFactory, and can be also used programmatically. |
|
| Method Summary | |
|---|---|
void |
addCache(CacheConfiguration cacheConfiguration)
Allows BeanHandler to add Cache Configurations to the configuration. |
void |
addCacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration)
Allows BeanHandler to add the CacheManagerEventListener to the configuration. |
void |
addCacheManagerPeerListenerFactory(FactoryConfiguration factory)
Adds a CacheManagerPeerListener through FactoryConfiguration. |
void |
addCacheManagerPeerProviderFactory(FactoryConfiguration factory)
Adds a CacheManagerPeerProvider through FactoryConfiguration. |
void |
addDefaultCache(CacheConfiguration defaultCacheConfiguration)
Allows BeanHandler to add a default configuration to the configuration. |
void |
addDiskStore(DiskStoreConfiguration diskStoreConfigurationParameter)
Allows BeanHandler to add disk store location to the configuration. |
void |
addTerracottaConfig(TerracottaClientConfiguration terracottaConfiguration)
Allows BeanHandler to add a Terracotta configuration to the configuration |
void |
addTransactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter)
Allows BeanHandler to add transaction manager lookup to the configuration. |
Configuration |
cache(CacheConfiguration cacheConfiguration)
Builder to add a new cache through its config |
Configuration |
cacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration)
Builder to set the event lister through a factory, only one of these can be added and subsequent calls are ignored. |
Configuration |
cacheManagerPeerListenerFactory(FactoryConfiguration factory)
Builder method to add a peer listener through a factory. |
Configuration |
cacheManagerPeerProviderFactory(FactoryConfiguration factory)
Builder method to add a peer provider through a factory. |
Configuration |
defaultCache(CacheConfiguration defaultCacheConfiguration)
Builder method to set the default cache configuration, this can only be used once. |
Configuration |
defaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds)
Builder to set the default transaction timeout. |
Configuration |
diskStore(DiskStoreConfiguration diskStoreConfigurationParameter)
Builder to add a disk store to the cache manager, only one disk store can be added. |
Configuration |
dynamicConfig(boolean dynamicConfig)
Builder to set the dynamic config capability |
java.util.Map<java.lang.String,CacheConfiguration> |
getCacheConfigurations()
Gets a Map of cache configurations, keyed by name. |
java.util.Set<java.lang.String> |
getCacheConfigurationsKeySet()
Gets a Map of cacheConfigurations. |
FactoryConfiguration |
getCacheManagerEventListenerFactoryConfiguration()
Gets the CacheManagerEventListener factory configuration. |
java.util.List<FactoryConfiguration> |
getCacheManagerPeerListenerFactoryConfigurations()
Gets the CacheManagerPeerListener factory configuration. |
java.util.List<FactoryConfiguration> |
getCacheManagerPeerProviderFactoryConfiguration()
Gets the CacheManagerPeerProvider factory configuration. |
ConfigurationSource |
getConfigurationSource()
Gets a description of the source from which this configuration was created. |
CacheConfiguration |
getDefaultCacheConfiguration()
|
int |
getDefaultTransactionTimeoutInSeconds()
Get default transaction timeout |
DiskStoreConfiguration |
getDiskStoreConfiguration()
Gets the disk store configuration. |
boolean |
getDynamicConfig()
Get flag for dynamicConfig |
Configuration.Monitoring |
getMonitoring()
Get monitoring type, should not be null |
java.lang.String |
getName()
CacheManager name |
TerracottaClientConfiguration |
getTerracottaConfiguration()
Gets the TerracottaClientConfiguration |
FactoryConfiguration |
getTransactionManagerLookupConfiguration()
Gets the transaction manager lookup configuration. |
boolean |
getUpdateCheck()
Get flag for updateCheck |
Configuration |
monitoring(Configuration.Monitoring monitoring)
Builder to set the monitoring approach |
Configuration |
name(java.lang.String name)
Builder to set the cache manager name. |
void |
setDefaultCacheConfiguration(CacheConfiguration defaultCacheConfiguration)
|
void |
setDefaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds)
Allows BeanHandler to set the default transaction timeout. |
void |
setDynamicConfig(boolean dynamicConfig)
Allows BeanHandler to set the dynamic configuration flag |
void |
setMonitoring(java.lang.String monitoring)
Allows BeanHandler to set the monitoring flag |
void |
setName(java.lang.String name)
Allows BeanHandler to set the CacheManager name. |
void |
setSource(ConfigurationSource configurationSource)
Sets the configuration source. |
void |
setUpdateCheck(boolean updateCheck)
Allows BeanHandler to set the updateCheck flag. |
Configuration |
source(ConfigurationSource configurationSource)
Builder to set the configuration source. |
Configuration |
terracotta(TerracottaClientConfiguration terracottaConfiguration)
Builder method to Terracotta capabilities to the cache manager through a dedicated configuration, this can only be used once. |
Configuration |
transactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter)
Builder to add a transaction manager lookup class to the cache manager, only one of these can be added. |
Configuration |
updateCheck(boolean updateCheck)
Builder to set the state of the automated update check. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final boolean DEFAULT_DYNAMIC_CONFIG
public static final boolean DEFAULT_UPDATE_CHECK
public static final int DEFAULT_TRANSACTION_TIMEOUT
public static final Configuration.Monitoring DEFAULT_MONITORING
public static final FactoryConfiguration DEFAULT_TRANSACTION_MANAGER_LOOKUP_CONFIG
| Constructor Detail |
|---|
public Configuration()
ConfigurationFactory, and can be also used programmatically.
If you are using it programmtically you need to call the relevant add and setter methods in this class to populate everything.
| Method Detail |
|---|
public final Configuration name(java.lang.String name)
name - the name to set
setName(String)public final void setName(java.lang.String name)
public final java.lang.String getName()
public final Configuration updateCheck(boolean updateCheck)
updateCheck - true if the update check should be turned on; or false otherwise
public final void setUpdateCheck(boolean updateCheck)
public final boolean getUpdateCheck()
public final Configuration defaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds)
defaultTransactionTimeoutInSeconds - the default transaction timeout in seconds
public final void setDefaultTransactionTimeoutInSeconds(int defaultTransactionTimeoutInSeconds)
public final int getDefaultTransactionTimeoutInSeconds()
public final Configuration monitoring(Configuration.Monitoring monitoring)
monitoring - an non-null instance of Configuration.Monitoring
public final void setMonitoring(java.lang.String monitoring)
public final Configuration.Monitoring getMonitoring()
public final Configuration dynamicConfig(boolean dynamicConfig)
dynamicConfig - true if dynamic config should be enabled; or false otherwise.
public final void setDynamicConfig(boolean dynamicConfig)
public final boolean getDynamicConfig()
public final Configuration diskStore(DiskStoreConfiguration diskStoreConfigurationParameter)
throws ObjectExistsException
diskStoreConfigurationParameter - the disk store configuration to use
ObjectExistsException - if the disk store has already been configured
public final void addDiskStore(DiskStoreConfiguration diskStoreConfigurationParameter)
throws ObjectExistsException
ObjectExistsException
public final Configuration transactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter)
throws ObjectExistsException
transactionManagerLookupParameter - the transaction manager lookup class to use
ObjectExistsException - if the transaction manager lookup has already been configured
public final void addTransactionManagerLookup(FactoryConfiguration transactionManagerLookupParameter)
throws ObjectExistsException
ObjectExistsExceptionpublic final Configuration cacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration)
public final void addCacheManagerEventListenerFactory(FactoryConfiguration cacheManagerEventListenerFactoryConfiguration)
public final Configuration cacheManagerPeerProviderFactory(FactoryConfiguration factory)
public final void addCacheManagerPeerProviderFactory(FactoryConfiguration factory)
public final Configuration cacheManagerPeerListenerFactory(FactoryConfiguration factory)
public final void addCacheManagerPeerListenerFactory(FactoryConfiguration factory)
public final Configuration terracotta(TerracottaClientConfiguration terracottaConfiguration)
throws ObjectExistsException
ObjectExistsException - if the Terracotta config has already been configured
public final void addTerracottaConfig(TerracottaClientConfiguration terracottaConfiguration)
throws ObjectExistsException
ObjectExistsException
public final Configuration defaultCache(CacheConfiguration defaultCacheConfiguration)
throws ObjectExistsException
ObjectExistsException - if the default cache config has already been configured
public final void addDefaultCache(CacheConfiguration defaultCacheConfiguration)
throws ObjectExistsException
ObjectExistsException
public final Configuration cache(CacheConfiguration cacheConfiguration)
throws ObjectExistsException
ObjectExistsException - if a cache with the same name already exists, or if the name conflicts with the name of the default cache
public final void addCache(CacheConfiguration cacheConfiguration)
throws ObjectExistsException
ObjectExistsExceptionpublic final java.util.Set<java.lang.String> getCacheConfigurationsKeySet()
public final CacheConfiguration getDefaultCacheConfiguration()
public final void setDefaultCacheConfiguration(CacheConfiguration defaultCacheConfiguration)
defaultCacheConfiguration - public final DiskStoreConfiguration getDiskStoreConfiguration()
public final FactoryConfiguration getTransactionManagerLookupConfiguration()
public final java.util.List<FactoryConfiguration> getCacheManagerPeerProviderFactoryConfiguration()
public final java.util.List<FactoryConfiguration> getCacheManagerPeerListenerFactoryConfigurations()
public final FactoryConfiguration getCacheManagerEventListenerFactoryConfiguration()
public final TerracottaClientConfiguration getTerracottaConfiguration()
public final java.util.Map<java.lang.String,CacheConfiguration> getCacheConfigurations()
public final Configuration source(ConfigurationSource configurationSource)
public final void setSource(ConfigurationSource configurationSource)
configurationSource - an informative description of the source, preferably
including the resource name and location.public final ConfigurationSource getConfigurationSource()
|
ehcache | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||