Top Description Fields Constructors Methods
net.sf.ehcache.management

public Class CacheConfiguration

extends Object
implements CacheConfigurationMBean, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, net.sf.ehcache.management.CacheConfigurationMBean
Imports
java.io.Serializable, javax.management.MalformedObjectNameException, .ObjectName, net.sf.ehcache.CacheException, net.sf.ehcache.config.TerracottaConfiguration.Consistency, net.sf.ehcache.hibernate.management.impl.EhcacheHibernateMbeanNames
A JMX MBean implementation and decorator to net.sf.ehcache.CacheConfiguration
Author
Greg Luck
Since
1.3
Version
$Id: CacheConfiguration.java 5594 2012-05-07 16:04:31Z cdennis $

Field Summary

Modifier and TypeField and Description
private final transient CacheConfiguration
cacheConfiguration

private final ObjectName
objectName

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
CacheConfiguration(Ehcache cache)

Constructs using a backing CacheConfiguration

Method Summary

Modifier and TypeMethod and Description
pack-priv static ObjectName
createObjectName(String cacheManagerName, String cacheName)

Creates an object name using the scheme "net.sf.ehcache:type=CacheConfiguration,CacheManager=<cachemanagername>,name=<cachename>"

public long
getDiskExpiryThreadIntervalSeconds()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getDiskExpiryThreadIntervalSeconds.

Accessor
public int
getDiskSpoolBufferSizeMB()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getDiskSpoolBufferSizeMB.

Accessor
public long
getMaxBytesLocalDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxBytesLocalDisk.

Maximum number of bytes that may be stored in the local disk store.
public long
getMaxBytesLocalHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxBytesLocalHeap.

Maximum number of bytes that may be stored in local heap memory store.
public long
getMaxBytesLocalOffHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxBytesLocalOffHeap.

Maximum number of bytes that may be stored in local off-heap memory store.
public int
getMaxElementsInMemory()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxElementsInMemory.

Deprecated use getMaxEntriesLocalHeap()
Accessor
public int
getMaxElementsOnDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxElementsOnDisk.

Deprecated use getMaxEntriesLocalDisk()
Accessor
public long
getMaxEntriesLocalDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxEntriesLocalDisk.

Maximum number of entries that may be stored in the local disk store.
public long
getMaxEntriesLocalHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxEntriesLocalHeap.

Maximum number of entries that may be stored in local heap memory store.
public long
getMaxMemoryOffHeapInBytes()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxMemoryOffHeapInBytes.

Deprecated use getMaxBytesLocalOffHeap()
Accessor
public String

Returns:

a String representation of the policy
getMemoryStoreEvictionPolicy()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMemoryStoreEvictionPolicy.

Accessor
public String
getName()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getName.

Accessor
pack-priv ObjectName

Returns:

the object name for this MBean
getObjectName()

public String
getTerracottaConsistency()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getTerracottaConsistency.

Accessor
public long
getTimeToIdleSeconds()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getTimeToIdleSeconds.

Accessor
public long
getTimeToLiveSeconds()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getTimeToLiveSeconds.

Accessor
public boolean
isDiskPersistent()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isDiskPersistent.

Accessor
public boolean
isEternal()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isEternal.

Accessor
public boolean
isLoggingEnabled()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isLoggingEnabled.

Accessor
public boolean
isOverflowToDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isOverflowToDisk.

Accessor
public boolean
isOverflowToOffHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isOverflowToOffHeap.

Accessor
public boolean
isTerracottaClustered()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isTerracottaClustered.

Accessor
public final void
setDiskExpiryThreadIntervalSeconds(long diskExpiryThreadIntervalSeconds)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setDiskExpiryThreadIntervalSeconds.

setDiskExpiryThreadIntervalSeconds
public void
setDiskPersistent(boolean diskPersistent)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setDiskPersistent.

setDiskPersistent
public void
setDiskSpoolBufferSizeMB(int diskSpoolBufferSizeMB)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setDiskSpoolBufferSizeMB.

setDiskSpoolBufferSizeMB
public void
setEternal(boolean eternal)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setEternal.

setEternal
public void
setLoggingEnabled(boolean enable)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setLoggingEnabled.

setLoggingEnabled
public void
setMaxElementsInMemory(int maxElements)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxElementsInMemory.

Deprecated use setMaxEntriesLocalHeap(long)
setMaxElementsInMemory
public void
setMaxElementsOnDisk(int maxElements)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxElementsOnDisk.

Deprecated use setMaxEntriesLocalDisk(long)
setMaxElementsOnDisk
public void
setMaxEntriesLocalDisk(long maxEntries)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxEntriesLocalDisk.

Maximum number of entries that may be stores in the local disk store.
public void
setMaxEntriesLocalHeap(long maxEntries)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxEntriesLocalHeap.

Maximum number of entries that may be stored in local heap memory store.
public void
setMemoryStoreEvictionPolicy(String memoryStoreEvictionPolicy)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMemoryStoreEvictionPolicy.

setMemoryStoreEvictionPolicy
public void
setOverflowToDisk(boolean overflowToDisk)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setOverflowToDisk.

setOverflowToDisk
public void
setTimeToIdleSeconds(long tti)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setTimeToIdleSeconds.

setTimeToIdleSeconds
public void
setTimeToLiveSeconds(long ttl)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setTimeToLiveSeconds.

setTimeToLiveSeconds
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cacheConfigurationback to summary
private final transient CacheConfiguration cacheConfiguration
objectNameback to summary
private final ObjectName objectName
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

CacheConfigurationback to summary
public CacheConfiguration(Ehcache cache)

Constructs using a backing CacheConfiguration

Method Detail

createObjectNameback to summary
pack-priv static ObjectName createObjectName(String cacheManagerName, String cacheName)

Creates an object name using the scheme "net.sf.ehcache:type=CacheConfiguration,CacheManager=,name="

getDiskExpiryThreadIntervalSecondsback to summary
public long getDiskExpiryThreadIntervalSeconds()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getDiskExpiryThreadIntervalSeconds.

Accessor

getDiskSpoolBufferSizeMBback to summary
public int getDiskSpoolBufferSizeMB()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getDiskSpoolBufferSizeMB.

Accessor

getMaxBytesLocalDiskback to summary
public long getMaxBytesLocalDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxBytesLocalDisk.

Maximum number of bytes that may be stored in the local disk store.

getMaxBytesLocalHeapback to summary
public long getMaxBytesLocalHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxBytesLocalHeap.

Maximum number of bytes that may be stored in local heap memory store.

getMaxBytesLocalOffHeapback to summary
public long getMaxBytesLocalOffHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxBytesLocalOffHeap.

Maximum number of bytes that may be stored in local off-heap memory store.

getMaxElementsInMemoryback to summary
public int getMaxElementsInMemory()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxElementsInMemory.

Deprecated

use getMaxEntriesLocalHeap()

Accessor

Annotations
@Deprecated
getMaxElementsOnDiskback to summary
public int getMaxElementsOnDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxElementsOnDisk.

Deprecated

use getMaxEntriesLocalDisk()

Accessor

Annotations
@Deprecated
getMaxEntriesLocalDiskback to summary
public long getMaxEntriesLocalDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxEntriesLocalDisk.

Maximum number of entries that may be stored in the local disk store.

getMaxEntriesLocalHeapback to summary
public long getMaxEntriesLocalHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxEntriesLocalHeap.

Maximum number of entries that may be stored in local heap memory store.

getMaxMemoryOffHeapInBytesback to summary
public long getMaxMemoryOffHeapInBytes()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMaxMemoryOffHeapInBytes.

Deprecated

use getMaxBytesLocalOffHeap()

Accessor

Annotations
@Deprecated
getMemoryStoreEvictionPolicyback to summary
public String getMemoryStoreEvictionPolicy()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getMemoryStoreEvictionPolicy.

Accessor

Returns:String

a String representation of the policy

getNameback to summary
public String getName()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getName.

Accessor

getObjectNameback to summary
pack-priv ObjectName getObjectName()
Returns:ObjectName

the object name for this MBean

getTerracottaConsistencyback to summary
public String getTerracottaConsistency()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getTerracottaConsistency.

Accessor

getTimeToIdleSecondsback to summary
public long getTimeToIdleSeconds()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getTimeToIdleSeconds.

Accessor

getTimeToLiveSecondsback to summary
public long getTimeToLiveSeconds()

Implements net.sf.ehcache.management.CacheConfigurationMBean.getTimeToLiveSeconds.

Accessor

isDiskPersistentback to summary
public boolean isDiskPersistent()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isDiskPersistent.

Accessor

isEternalback to summary
public boolean isEternal()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isEternal.

Accessor

isLoggingEnabledback to summary
public boolean isLoggingEnabled()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isLoggingEnabled.

Accessor

isOverflowToDiskback to summary
public boolean isOverflowToDisk()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isOverflowToDisk.

Accessor

isOverflowToOffHeapback to summary
public boolean isOverflowToOffHeap()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isOverflowToOffHeap.

Accessor

isTerracottaClusteredback to summary
public boolean isTerracottaClustered()

Implements net.sf.ehcache.management.CacheConfigurationMBean.isTerracottaClustered.

Accessor

setDiskExpiryThreadIntervalSecondsback to summary
public final void setDiskExpiryThreadIntervalSeconds(long diskExpiryThreadIntervalSeconds)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setDiskExpiryThreadIntervalSeconds.

setDiskExpiryThreadIntervalSeconds

setDiskPersistentback to summary
public void setDiskPersistent(boolean diskPersistent)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setDiskPersistent.

setDiskPersistent

setDiskSpoolBufferSizeMBback to summary
public void setDiskSpoolBufferSizeMB(int diskSpoolBufferSizeMB)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setDiskSpoolBufferSizeMB.

setDiskSpoolBufferSizeMB

setEternalback to summary
public void setEternal(boolean eternal)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setEternal.

setEternal

setLoggingEnabledback to summary
public void setLoggingEnabled(boolean enable)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setLoggingEnabled.

setLoggingEnabled

setMaxElementsInMemoryback to summary
public void setMaxElementsInMemory(int maxElements)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxElementsInMemory.

Deprecated

use setMaxEntriesLocalHeap(long)

setMaxElementsInMemory

Annotations
@Deprecated
setMaxElementsOnDiskback to summary
public void setMaxElementsOnDisk(int maxElements)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxElementsOnDisk.

Deprecated

use setMaxEntriesLocalDisk(long)

setMaxElementsOnDisk

Annotations
@Deprecated
setMaxEntriesLocalDiskback to summary
public void setMaxEntriesLocalDisk(long maxEntries)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxEntriesLocalDisk.

Maximum number of entries that may be stores in the local disk store.

setMaxEntriesLocalHeapback to summary
public void setMaxEntriesLocalHeap(long maxEntries)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMaxEntriesLocalHeap.

Maximum number of entries that may be stored in local heap memory store.

setMemoryStoreEvictionPolicyback to summary
public void setMemoryStoreEvictionPolicy(String memoryStoreEvictionPolicy)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setMemoryStoreEvictionPolicy.

setMemoryStoreEvictionPolicy

setOverflowToDiskback to summary
public void setOverflowToDisk(boolean overflowToDisk)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setOverflowToDisk.

setOverflowToDisk

setTimeToIdleSecondsback to summary
public void setTimeToIdleSeconds(long tti)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setTimeToIdleSeconds.

setTimeToIdleSeconds

setTimeToLiveSecondsback to summary
public void setTimeToLiveSeconds(long ttl)

Implements net.sf.ehcache.management.CacheConfigurationMBean.setTimeToLiveSeconds.

setTimeToLiveSeconds