ehcache-core 2.10.9.2 · net.sf.ehcache.config.TerracottaConfiguration

Modifier and Type	Class and Description
public static enum	TerracottaConfiguration.Consistency Enum for various consistency settings

Field Summary

Modifier and Type	Field and Description
private boolean	cacheXA
private boolean	clustered
private boolean	coherentReads
private volatile boolean	compressionEnabled
private int	concurrency
private TerracottaConfiguration.Consistency	consistency
private boolean	copyOnReadSet
public static final boolean	DEFAULT_CACHE_COHERENT Default cache coherence setting
public static final boolean	DEFAULT_CACHE_XA Default xa enabled
public static final boolean	DEFAULT_CLUSTERED Default clustered mode
public static final boolean	DEFAULT_COHERENT_READS Default coherent read behavior
public static final boolean	DEFAULT_COMPRESSION_ENABLED Default compression setting
public static final int	DEFAULT_CONCURRENCY Default value for concurrency of the internal Store.
public static final TerracottaConfiguration.Consistency	DEFAULT_CONSISTENCY_TYPE Default cache consistency setting
public static final boolean	DEFAULT_COPY_ON_READ Default copy on read setting
public static final boolean	DEFAULT_LOCAL_CACHE_ENABLED Default value for whether local cache is enabled or not
public static final boolean	DEFAULT_LOCAL_KEY_CACHE Default local key cache status
public static final int	DEFAULT_LOCAL_KEY_CACHE_SIZE Default local key cache size
public static final NonstopConfiguration	DEFAULT_NON_STOP_CONFIGURATION Default value for `NonstopConfiguration`
public static final boolean	DEFAULT_ORPHAN_EVICTION Default orphan eviction status
public static final int	DEFAULT_ORPHAN_EVICTION_PERIOD Default orphan eviction period
public static final boolean	DEFAULT_SYNCHRONOUS_WRITES Default setting for synchronous-write
private boolean	isCopyOnRead
private volatile boolean	localCacheEnabled
private boolean	localKeyCache
private int	localKeyCacheSize
private static final Logger	LOG
private NonstopConfiguration	nonStopConfiguration
private boolean	orphanEviction
private int	orphanEvictionPeriod
private boolean	synchronousWrites

Constructor Summary

Access	Constructor and Description
public	TerracottaConfiguration()

Method Summary

Modifier and Type	Method and Description
public void	addNonstop(NonstopConfiguration nonstopConfiguration) Add the `NonstopConfiguration`
private void	assertArgumentNotNull(String name, Object object)
public TerracottaConfiguration	Returns: this configuration instance cacheXA(boolean cacheXA)
public TerracottaConfiguration	Returns: a copy, which independent other than configurations than cannot change. clone() Overrides java.lang.Object.clone. Clones this object, following the usual contract.
public TerracottaConfiguration	Returns: this configuration instance clustered(boolean clustered)
public TerracottaConfiguration	Returns: this configuration instance coherent(boolean coherent) Deprecated since 2.4 Use `consistency(Consistency)` instead
public TerracottaConfiguration	Returns: this configuration instance coherentReads(boolean coherentReads) Deprecated
public TerracottaConfiguration	Returns: this configuration instance compressionEnabled(boolean enabled)
public TerracottaConfiguration	Returns: this configuration instance concurrency(final int concurrency)
public TerracottaConfiguration	Returns: this instance consistency(TerracottaConfiguration.Consistency consistency) Setter for consistency, returns this instance
public TerracottaConfiguration	Returns: this configuration instance copyOnRead(boolean isCopyOnRead) Deprecated
public boolean	getCoherentReads() Deprecated Check whether coherent reads are enabled
public int	getConcurrency() Get the value of concurrency.
public TerracottaConfiguration.Consistency	Returns: the consistency getConsistency() Getter for consistency
public boolean	getLocalKeyCache() Check whether the local key cache is enabled
public int	getLocalKeyCacheSize() Get the size limit of the local key cache (if enabled)
public NonstopConfiguration	Returns: the `NonstopConfiguration`, may be null getNonstopConfiguration() Get the `NonstopConfiguration`, may be null
public boolean	getOrphanEviction() Check whether orphan eviction is enabled
public int	getOrphanEvictionPeriod() Get the number of regular eviction cycles between orphan evictions
public boolean	isCacheXA() Check whether the [serialized value] cache is an XA enabled cache
public boolean	isClustered() Check whether clustering is enabled
public boolean	Returns: true if configured in coherent mode. isCoherent() Deprecated since 2.4 Use `getConsistency()` instead to query the `Consistency` or Ehcache#isNodeCoherent() to query if the node is coherent Is the cache configured for coherent or incoherent mode.
public boolean	isCompressionEnabled() Check whether compression is enabled
public boolean	isCopyOnRead() Deprecated Check whether the [serialized value] cache should use copy on read semantics
pack-priv boolean	Returns: true if set by config isCopyOnReadSet() Whether the copyOnRead was explicitly set
public boolean	Returns: true if local cache is enabled, otherwise false isLocalCacheEnabled() Returns true if local cache is enabled, otherwise false
public boolean	Returns: true if nonstop is enabled isNonstopEnabled() Returns true if nonstop is enabled
public boolean	Returns: true if configured for synchronouse-write, otherwise false. Default is false isSynchronousWrites() Is the cache configured for synchronous-write?
public TerracottaConfiguration	Returns: this instance localCacheEnabled(final boolean localCacheEnabled) Enable or disable the local cache
public TerracottaConfiguration	Returns: this configuration instance localKeyCache(boolean localKeyCache)
public TerracottaConfiguration	Returns: this configuration instance localKeyCacheSize(int localKeyCacheSize)
private static NonstopConfiguration	makeDefaultNonstopConfiguration()
public TerracottaConfiguration	Returns: this configuration instance nonstop(NonstopConfiguration nonstopConfiguration) Set the `NonstopConfiguration`
public TerracottaConfiguration	Returns: this configuration instance orphanEviction(boolean orphanEviction)
public TerracottaConfiguration	Returns: this configuration instance orphanEvictionPeriod(int orphanEvictionPeriod)
public void	setCacheXA(boolean cacheXA) Used by BeanHandler to set the cacheXA flag during parsing
public void	setClustered(boolean `true` if the cache should be clustered with Terracotta; `false` otherwise clustered) Indicates whether to cluster this cache with Terracotta.
public void	setCoherent(boolean coherent) Deprecated since 2.4 Use `setConsistency(Consistency)` instead Used by BeanHandler to set the `coherent` during parsing
public void	setCoherentReads(boolean `true` if coherent reads should be used; `false` otherwise coherentReads) Deprecated Sets whether this cache should use coherent reads (usually should be true unless optimizing for read-only).
public void	setCompressionEnabled(boolean enabled) Used by BeanHandler to set the compressionEnabled flag during parsing
public void	setConcurrency(final int concurrency) Sets the value of concurrency.
public void	setConsistency(TerracottaConfiguration.Consistency consistency) Setter for consistency
public void	setConsistency(String consistency) Setter for consistency
public void	setCopyOnRead(boolean isCopyOnRead) Deprecated Used by BeanHandler to set the copyOnRead flag during parsing
public void	setLocalCacheEnabled(final boolean localCacheEnabled) Enable or disable the local cache
public void	setLocalKeyCache(boolean `true` if a local key cache should be used; `false` otherwise localKeyCache) Sets whether this cache should use an unclustered local key cache (usually should be false unless optimizing for a small read-only cache) Defaults to false.
public void	setLocalKeyCacheSize(int the size of the local key cache in number of keys localKeyCacheSize) Sets maximum size of the local key cache (usually the size of the key set of the cache or cache partition).
public void	setOrphanEviction(boolean `true` if orphan eviction should be used; `false` otherwise orphanEviction) Sets whether this cache should perform orphan eviction (usually should be true).
public void	setOrphanEvictionPeriod(int every how many regular evictions an orphan eviction should occur orphanEvictionPeriod) Set how often this cache should perform orphan eviction (measured in regular eviction periods).
public void	setSynchronousWrites(boolean true for using synchronous-write synchronousWrites) Set the value for synchronous-write
public TerracottaConfiguration	Returns: this configuration instance synchronousWrites(boolean synchronousWrites)

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cacheXA	back to summary
private boolean cacheXA

clustered	back to summary
private boolean clustered

coherentReads	back to summary
private boolean coherentReads

compressionEnabled	back to summary
private volatile boolean compressionEnabled

concurrency	back to summary
private int concurrency

consistency	back to summary
private TerracottaConfiguration.Consistency consistency

copyOnReadSet	back to summary
private boolean copyOnReadSet

DEFAULT_CACHE_COHERENT	back to summary
public static final boolean DEFAULT_CACHE_COHERENT Deprecated since 2.4 Use `DEFAULT_CONSISTENCY_TYPE` instead. Default cache coherence setting Annotations @Deprecated

DEFAULT_CACHE_XA	back to summary
public static final boolean DEFAULT_CACHE_XA Default xa enabled

DEFAULT_CLUSTERED	back to summary
public static final boolean DEFAULT_CLUSTERED Default clustered mode

DEFAULT_COHERENT_READS	back to summary
public static final boolean DEFAULT_COHERENT_READS Default coherent read behavior

DEFAULT_COMPRESSION_ENABLED	back to summary
public static final boolean DEFAULT_COMPRESSION_ENABLED Default compression setting

DEFAULT_CONCURRENCY	back to summary
public static final int DEFAULT_CONCURRENCY Default value for concurrency of the internal Store.

DEFAULT_CONSISTENCY_TYPE	back to summary
public static final TerracottaConfiguration.Consistency DEFAULT_CONSISTENCY_TYPE Default cache consistency setting

DEFAULT_COPY_ON_READ	back to summary
public static final boolean DEFAULT_COPY_ON_READ Default copy on read setting

DEFAULT_LOCAL_CACHE_ENABLED	back to summary
public static final boolean DEFAULT_LOCAL_CACHE_ENABLED Default value for whether local cache is enabled or not

DEFAULT_LOCAL_KEY_CACHE	back to summary
public static final boolean DEFAULT_LOCAL_KEY_CACHE Default local key cache status

DEFAULT_LOCAL_KEY_CACHE_SIZE	back to summary
public static final int DEFAULT_LOCAL_KEY_CACHE_SIZE Default local key cache size

DEFAULT_NON_STOP_CONFIGURATION	back to summary
public static final NonstopConfiguration DEFAULT_NON_STOP_CONFIGURATION Default value for `NonstopConfiguration`

DEFAULT_ORPHAN_EVICTION	back to summary
public static final boolean DEFAULT_ORPHAN_EVICTION Default orphan eviction status

DEFAULT_ORPHAN_EVICTION_PERIOD	back to summary
public static final int DEFAULT_ORPHAN_EVICTION_PERIOD Default orphan eviction period

DEFAULT_SYNCHRONOUS_WRITES	back to summary
public static final boolean DEFAULT_SYNCHRONOUS_WRITES Default setting for synchronous-write

isCopyOnRead	back to summary
private boolean isCopyOnRead

localCacheEnabled	back to summary
private volatile boolean localCacheEnabled

localKeyCache	back to summary
private boolean localKeyCache

localKeyCacheSize	back to summary
private int localKeyCacheSize

LOG	back to summary
private static final Logger LOG

nonStopConfiguration	back to summary
private NonstopConfiguration nonStopConfiguration

orphanEviction	back to summary
private boolean orphanEviction

orphanEvictionPeriod	back to summary
private int orphanEvictionPeriod

synchronousWrites	back to summary
private boolean synchronousWrites

Constructor Detail

TerracottaConfiguration	back to summary
public TerracottaConfiguration()

Method Detail

addNonstop	back to summary
public void addNonstop(NonstopConfiguration nonstopConfiguration) Add the `NonstopConfiguration`

assertArgumentNotNull	back to summary
private void assertArgumentNotNull(String name, Object object)

cacheXA	back to summary
public TerracottaConfiguration cacheXA(boolean cacheXA) Returns:TerracottaConfiguration this configuration instance See Also `setCacheXA(boolean)`

clone	back to summary
public TerracottaConfiguration clone() Overrides java.lang.Object.clone. Clones this object, following the usual contract. Returns:TerracottaConfiguration a copy, which independent other than configurations than cannot change. Annotations @Override

clone

back to summary

public TerracottaConfiguration clone()

Overrides java.lang.Object.clone.

Clones this object, following the usual contract.

Returns:TerracottaConfiguration

a copy, which independent other than configurations than cannot change.

Annotations

@Override

clustered	back to summary
public TerracottaConfiguration clustered(boolean clustered) Returns:TerracottaConfiguration this configuration instance See Also `setClustered(boolean)`

coherent	back to summary
public TerracottaConfiguration coherent(boolean coherent) Deprecated since 2.4 Use `consistency(Consistency)` instead Returns:TerracottaConfiguration this configuration instance Annotations @Deprecated

coherentReads	back to summary
public TerracottaConfiguration coherentReads(boolean coherentReads) Deprecated Returns:TerracottaConfiguration this configuration instance Annotations @Deprecated See Also `setCoherentReads(boolean)`

compressionEnabled	back to summary
public TerracottaConfiguration compressionEnabled(boolean enabled) Returns:TerracottaConfiguration this configuration instance

concurrency	back to summary
public TerracottaConfiguration concurrency(final int concurrency) Returns:TerracottaConfiguration this configuration instance See Also `setConcurrency(int)`

consistency	back to summary
public TerracottaConfiguration consistency(TerracottaConfiguration.Consistency consistency) Setter for consistency, returns this instance Returns:TerracottaConfiguration this instance

consistency

back to summary

public TerracottaConfiguration consistency(TerracottaConfiguration.Consistency consistency)

Setter for consistency, returns this instance

Returns:TerracottaConfiguration: this instance

copyOnRead	back to summary
public TerracottaConfiguration copyOnRead(boolean isCopyOnRead) Deprecated Returns:TerracottaConfiguration this configuration instance Annotations @Deprecated See Also `setCopyOnRead(boolean)`

getCoherentReads	back to summary
public boolean getCoherentReads() Deprecated Check whether coherent reads are enabled Annotations @Deprecated

getCoherentReads

back to summary

public boolean getCoherentReads()

Deprecated

Check whether coherent reads are enabled

Annotations

@Deprecated

getConcurrency	back to summary
public int getConcurrency() Get the value of concurrency. This value cannot be changed once cache is initialized.

getConsistency	back to summary
public TerracottaConfiguration.Consistency getConsistency() Getter for consistency Returns:TerracottaConfiguration.Consistency the consistency

getConsistency

back to summary

public TerracottaConfiguration.Consistency getConsistency()

Getter for consistency

Returns:TerracottaConfiguration.Consistency: the consistency

getLocalKeyCache	back to summary
public boolean getLocalKeyCache() Check whether the local key cache is enabled

getLocalKeyCacheSize	back to summary
public int getLocalKeyCacheSize() Get the size limit of the local key cache (if enabled)

getNonstopConfiguration back to summary

public NonstopConfiguration getNonstopConfiguration()

Get the NonstopConfiguration, may be null

Returns:NonstopConfiguration: the NonstopConfiguration, may be null

getOrphanEviction	back to summary
public boolean getOrphanEviction() Check whether orphan eviction is enabled

getOrphanEvictionPeriod	back to summary
public int getOrphanEvictionPeriod() Get the number of regular eviction cycles between orphan evictions

isCacheXA	back to summary
public boolean isCacheXA() Check whether the [serialized value] cache is an XA enabled cache

isClustered	back to summary
public boolean isClustered() Check whether clustering is enabled

isCoherent back to summary

public boolean isCoherent()

Deprecated

since 2.4 Use getConsistency() instead to query the Consistency or Ehcache#isNodeCoherent() to query if the node is coherent

Is the cache configured for coherent or incoherent mode.

Returns:boolean

true if configured in coherent mode.

Annotations

@Deprecated

isCompressionEnabled	back to summary
public boolean isCompressionEnabled() Check whether compression is enabled

isCopyOnRead

back to summary

public boolean isCopyOnRead()

Deprecated

Check whether the [serialized value] cache should use copy on read semantics

Annotations

@Deprecated

isCopyOnReadSet

back to summary

pack-priv boolean isCopyOnReadSet()

Whether the copyOnRead was explicitly set

Returns:boolean: true if set by config

isLocalCacheEnabled

back to summary

public boolean isLocalCacheEnabled()

Returns true if local cache is enabled, otherwise false

Returns:boolean: true if local cache is enabled, otherwise false

isNonstopEnabled

back to summary

public boolean isNonstopEnabled()

Returns true if nonstop is enabled

Returns:boolean: true if nonstop is enabled

isSynchronousWrites

back to summary

public boolean isSynchronousWrites()

Is the cache configured for synchronous-write?

Returns:boolean: true if configured for synchronouse-write, otherwise false. Default is false

localCacheEnabled

back to summary

public TerracottaConfiguration localCacheEnabled(final boolean localCacheEnabled)

Enable or disable the local cache

Returns:TerracottaConfiguration: this instance

localKeyCache	back to summary
public TerracottaConfiguration localKeyCache(boolean localKeyCache) Returns:TerracottaConfiguration this configuration instance See Also `setLocalKeyCache(boolean)`

localKeyCacheSize	back to summary
public TerracottaConfiguration localKeyCacheSize(int localKeyCacheSize) Returns:TerracottaConfiguration this configuration instance See Also `setLocalKeyCacheSize(int)`

makeDefaultNonstopConfiguration	back to summary
private static NonstopConfiguration makeDefaultNonstopConfiguration()

nonstop back to summary

public TerracottaConfiguration nonstop(NonstopConfiguration nonstopConfiguration)

Set the NonstopConfiguration

Returns:TerracottaConfiguration: this configuration instance

orphanEviction	back to summary
public TerracottaConfiguration orphanEviction(boolean orphanEviction) Returns:TerracottaConfiguration this configuration instance See Also `setOrphanEviction(boolean)`

orphanEvictionPeriod	back to summary
public TerracottaConfiguration orphanEvictionPeriod(int orphanEvictionPeriod) Returns:TerracottaConfiguration this configuration instance See Also `setOrphanEvictionPeriod(int)`

setCacheXA	back to summary
public void setCacheXA(boolean cacheXA) Used by BeanHandler to set the cacheXA flag during parsing

setClustered back to summary

public void setClustered(boolean clustered)

Indicates whether to cluster this cache with Terracotta.

Defaults to true.

Parameters

clustered:boolean: true if the cache should be clustered with Terracotta; false otherwise

setCoherent back to summary

public void setCoherent(boolean coherent)

Deprecated

since 2.4 Use setConsistency(Consistency) instead

Used by BeanHandler to set the coherent during parsing

Annotations

@Deprecated

setCoherentReads back to summary

public void setCoherentReads(boolean coherentReads)

Deprecated

Sets whether this cache should use coherent reads (usually should be true unless optimizing for read-only).

Defaults to true.

Parameters

coherentReads:boolean: true if coherent reads should be used; false otherwise

Annotations

@Deprecated

setCompressionEnabled	back to summary
public void setCompressionEnabled(boolean enabled) Used by BeanHandler to set the compressionEnabled flag during parsing

setConcurrency	back to summary
public void setConcurrency(final int concurrency) Sets the value of concurrency. Throws `IllegalArgumentException` if the value is less than 0. This value cannot be changed once cache is initialized.

setConsistency	back to summary
public void setConsistency(TerracottaConfiguration.Consistency consistency) Setter for consistency

setConsistency	back to summary
public void setConsistency(String consistency) Setter for consistency

setCopyOnRead

back to summary

public void setCopyOnRead(boolean isCopyOnRead)

Deprecated

Used by BeanHandler to set the copyOnRead flag during parsing

Annotations

@Deprecated

setLocalCacheEnabled	back to summary
public void setLocalCacheEnabled(final boolean localCacheEnabled) Enable or disable the local cache

setLocalKeyCache back to summary

public void setLocalKeyCache(boolean localKeyCache)

Sets whether this cache should use an unclustered local key cache (usually should be false unless optimizing for a small read-only cache)

Defaults to false.

Parameters

localKeyCache:boolean: true if a local key cache should be used; false otherwise

setLocalKeyCacheSize

back to summary

public void setLocalKeyCacheSize(int localKeyCacheSize)

Sets maximum size of the local key cache (usually the size of the key set of the cache or cache partition).

Defaults to 300000.

Parameters

localKeyCacheSize:int: the size of the local key cache in number of keys

setOrphanEviction back to summary

public void setOrphanEviction(boolean orphanEviction)

Sets whether this cache should perform orphan eviction (usually should be true).

Orphans are elements that are not present on any node in the cluster anymore and hence need additional routines to be detected since they're not locally available anywhere.

Defaults to true.

Parameters

orphanEviction:boolean: true if orphan eviction should be used; false otherwise

setOrphanEvictionPeriod

back to summary

public void setOrphanEvictionPeriod(int orphanEvictionPeriod)

Set how often this cache should perform orphan eviction (measured in regular eviction periods).

Defaults to 4).

Parameters

orphanEvictionPeriod:int: every how many regular evictions an orphan eviction should occur

setSynchronousWrites

back to summary

public void setSynchronousWrites(boolean synchronousWrites)

Set the value for synchronous-write

Parameters

synchronousWrites:boolean: true for using synchronous-write

synchronousWrites	back to summary
public TerracottaConfiguration synchronousWrites(boolean synchronousWrites) Returns:TerracottaConfiguration this configuration instance See Also `setSynchronousWrites(boolean)`

Modifier and Type	Method and Description
public static TerracottaConfiguration.Consistency	valueOf(String name)
public static TerracottaConfiguration.Consistency[]	values()

public Class TerracottaConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum TerracottaConfiguration.Consistency

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final TerracottaConfiguration.Consistency	EVENTUAL Eventual consistency
public static final TerracottaConfiguration.Consistency	STRONG Strong consistency