ehcache-core 2.10.9.2 · net.sf.ehcache.management.sampled.SampledCacheManager

Modifier and Type	Field and Description
private String	mbeanRegisteredName
private volatile boolean	mbeanRegisteredNameSet
private static final MBeanNotificationInfo[]	NOTIFICATION_INFO
private final CacheManagerSampler	sampledCacheManagerDelegate

Access	Constructor and Description
public	SampledCacheManager(CacheManager the cacheManager to wrap cacheManager) Constructor taking the backing `CacheManager`

Modifier and Type	Method and Description
public void	clearAll() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.clearAll. Clears the contents of all caches in the CacheManager, but without removing any caches.
protected void	doDispose() Implements abstract net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.doDispose. Dispose callback of subclasses
public Object[][]	executeQuery(String queryString) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.executeQuery. Execute a BMSQL query against the CacheManager and return result grid.
public String	Returns: CacheManager configuration as String generateActiveConfigDeclaration() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.generateActiveConfigDeclaration. generateActiveConfigDeclaration
public String	Returns: Cache configuration as String generateActiveConfigDeclaration(String cacheName) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.generateActiveConfigDeclaration. generateActiveConfigDeclaration
public float	Returns: aggregate average get time (ms.) getCacheAverageGetTime() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheAverageGetTime.
public long	Returns: aggregate search time getCacheAverageSearchTime() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheAverageSearchTime.
public long	Returns: aggregate eviction rate getCacheEvictionRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheEvictionRate.
public long	Returns: aggregate expiration rate getCacheExpirationRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheExpirationRate.
public long	Returns: aggregate hit rate getCacheHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheHitRate.
public long	Returns: aggregate in-memory hit rate getCacheInMemoryHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheInMemoryHitRate.
public long	Returns: aggregate in-memory miss rate getCacheInMemoryMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheInMemoryMissRate.
private Map<String, Object>	getCacheManagerAttributes()
public Map<String, long[]>	Returns: map of cache metrics (hits, misses) getCacheMetrics() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMetrics. Get a map of cache name to performance metrics (hits, misses).
public long	Returns: aggregate miss rate getCacheMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMissRate.
public String[]	getCacheNames() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheNames. Gets the cache names managed by the CacheManager
public long	Returns: aggregate off-heap hit rate getCacheOffHeapHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOffHeapHitRate.
public long	Returns: aggregate off-heap miss rate getCacheOffHeapMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOffHeapMissRate.
public long	Returns: aggregate on-disk hit rate getCacheOnDiskHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOnDiskHitRate.
public long	Returns: aggregate on-disk miss rate getCacheOnDiskMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOnDiskMissRate.
public long	Returns: aggregate put rate getCachePutRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCachePutRate.
public long	Returns: aggregate remove rate getCacheRemoveRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheRemoveRate.
public long	Returns: aggregate search rate getCacheSearchRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheSearchRate.
public long	Returns: aggregate update rate getCacheUpdateRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheUpdateRate.
public String	getClusterUUID() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getClusterUUID. Gets the cluster uuid if applicable.
public boolean	getHasWriteBehindWriter() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getHasWriteBehindWriter. Returns whether any caches are configured for write-behind
public long	getMaxBytesLocalDisk() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDisk. Maximum number of bytes of entries in the disk stores of all caches that did not declare their own max size.
public String	getMaxBytesLocalDiskAsString() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDiskAsString.
public long	getMaxBytesLocalHeap() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeap. Maximum number of bytes of entries in the heap memory stores of all caches that did not declare their own max size.
public String	getMaxBytesLocalHeapAsString() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeapAsString.
public long	getMaxBytesLocalOffHeap() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeap. Maximum number of bytes of entries in the off-heap stores of all caches that did not declare their own max size.
public String	getMaxBytesLocalOffHeapAsString() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeapAsString.
public String	getMBeanRegisteredName() Implements net.sf.ehcache.management.sampled.SampledCacheManagerMBean.getMBeanRegisteredName. Gets the name used to register this mbean.
public String	getName() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getName. Gets the actual name of the cache manager.
public MBeanNotificationInfo[]	getNotificationInfo() Implements abstract net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.getNotificationInfo. Implements javax.management.NotificationBroadcaster.getNotificationInfo. Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
public boolean	getSearchable() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getSearchable.
public String	getStatus() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getStatus. Gets the status attribute of the Ehcache
public boolean	getTransactional() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactional. Are any of the caches transactional
public long	getTransactionCommitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommitRate.
public long	getTransactionCommittedCount() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommittedCount. Get the committed transactions count
public long	getTransactionRollbackRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRollbackRate.
public long	getTransactionRolledBackCount() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRolledBackCount. Get the rolled back transactions count
public long	getTransactionTimedOutCount() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionTimedOutCount. Get the timed out transactions count.
public int	getWriterMaxQueueSize() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getWriterMaxQueueSize. Maximum elements that can be queued for processing by the write-behind writer
public long	Returns: aggregate writer queue length getWriterQueueLength() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getWriterQueueLength. Returns the total length of all write-behind queues across all caches
public boolean	isEnabled() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.isEnabled. Returns if each contained cache is enabled.
public void	setEnabled(boolean enabled) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setEnabled. Enables/disables each of the contained caches.
public void	setMaxBytesLocalDisk(long maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalDisk.
public void	setMaxBytesLocalDiskAsString(String maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalDiskAsString.
public void	setMaxBytesLocalHeap(long maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalHeap.
public void	setMaxBytesLocalHeapAsString(String maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalHeapAsString.
pack-priv void	setMBeanRegisteredName(String the MBean name to be registered. name) Set the name used to register this mbean.
public void	shutdown() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.shutdown. Shuts down the CacheManager.

mbeanRegisteredName	back to summary
private String mbeanRegisteredName

mbeanRegisteredNameSet	back to summary
private volatile boolean mbeanRegisteredNameSet

NOTIFICATION_INFO	back to summary
private static final MBeanNotificationInfo[] NOTIFICATION_INFO

sampledCacheManagerDelegate	back to summary
private final CacheManagerSampler sampledCacheManagerDelegate

SampledCacheManager	back to summary
public SampledCacheManager(CacheManager cacheManager) throws NotCompliantMBeanException Constructor taking the backing `CacheManager` Parameters cacheManager:CacheManager the cacheManager to wrap Exceptions NotCompliantMBeanException: if invalid object is registered

Method Detail

clearAll back to summary

clearAll	back to summary
public void clearAll() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.clearAll. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.clearAll. Clears the contents of all caches in the CacheManager, but without removing any caches. This method is not synchronized. It only guarantees to clear those elements in a cache at the time that the `net.sf.ehcache.Ehcache#removeAll()` mehod on each cache is called.

public void clearAll()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.clearAll.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.clearAll.

Clears the contents of all caches in the CacheManager, but without removing any caches.

This method is not synchronized. It only guarantees to clear those elements in a cache at the time that the net.sf.ehcache.Ehcache#removeAll() mehod on each cache is called.

doDispose	back to summary
protected void doDispose() Implements abstract net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.doDispose. Doc from net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.doDispose. Dispose callback of subclasses Annotations @Override

doDispose

back to summary

protected void doDispose()

Implements abstract net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.doDispose.

Doc from net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.doDispose.

Dispose callback of subclasses

Annotations

@Override

executeQuery	back to summary
public Object[][] executeQuery(String queryString) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.executeQuery. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.executeQuery. Execute a BMSQL query against the CacheManager and return result grid. Returns:Object[][] query result grid Annotations @Override

executeQuery

back to summary

public Object[][] executeQuery(String queryString)

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.executeQuery.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.executeQuery.

Execute a BMSQL query against the CacheManager and return result grid.

Returns:Object[][]

query result grid

Annotations

@Override

generateActiveConfigDeclaration	back to summary
public String generateActiveConfigDeclaration() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.generateActiveConfigDeclaration. generateActiveConfigDeclaration Returns:String CacheManager configuration as String

generateActiveConfigDeclaration

back to summary

public String generateActiveConfigDeclaration()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.generateActiveConfigDeclaration.

generateActiveConfigDeclaration

Returns:String: CacheManager configuration as String

generateActiveConfigDeclaration	back to summary
public String generateActiveConfigDeclaration(String cacheName) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.generateActiveConfigDeclaration. generateActiveConfigDeclaration Returns:String Cache configuration as String

generateActiveConfigDeclaration

back to summary

public String generateActiveConfigDeclaration(String cacheName)

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.generateActiveConfigDeclaration.

generateActiveConfigDeclaration

Returns:String: Cache configuration as String

getCacheAverageGetTime	back to summary
public float getCacheAverageGetTime() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheAverageGetTime. Returns:float aggregate average get time (ms.)

getCacheAverageGetTime

back to summary

public float getCacheAverageGetTime()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheAverageGetTime.

Returns:float: aggregate average get time (ms.)

getCacheAverageSearchTime	back to summary
public long getCacheAverageSearchTime() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheAverageSearchTime. Returns:long aggregate search time

getCacheAverageSearchTime

back to summary

public long getCacheAverageSearchTime()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheAverageSearchTime.

Returns:long: aggregate search time

getCacheEvictionRate	back to summary
public long getCacheEvictionRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheEvictionRate. Returns:long aggregate eviction rate

getCacheEvictionRate

back to summary

public long getCacheEvictionRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheEvictionRate.

Returns:long: aggregate eviction rate

getCacheExpirationRate	back to summary
public long getCacheExpirationRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheExpirationRate. Returns:long aggregate expiration rate

getCacheExpirationRate

back to summary

public long getCacheExpirationRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheExpirationRate.

Returns:long: aggregate expiration rate

getCacheHitRate	back to summary
public long getCacheHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheHitRate. Returns:long aggregate hit rate

getCacheHitRate

back to summary

public long getCacheHitRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheHitRate.

Returns:long: aggregate hit rate

getCacheInMemoryHitRate	back to summary
public long getCacheInMemoryHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheInMemoryHitRate. Returns:long aggregate in-memory hit rate

getCacheInMemoryHitRate

back to summary

public long getCacheInMemoryHitRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheInMemoryHitRate.

Returns:long: aggregate in-memory hit rate

getCacheInMemoryMissRate	back to summary
public long getCacheInMemoryMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheInMemoryMissRate. Returns:long aggregate in-memory miss rate

getCacheInMemoryMissRate

back to summary

public long getCacheInMemoryMissRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheInMemoryMissRate.

Returns:long: aggregate in-memory miss rate

getCacheManagerAttributes	back to summary
private Map<String, Object> getCacheManagerAttributes()

getCacheMetrics	back to summary
public Map<String, long[]> getCacheMetrics() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMetrics. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMetrics. Get a map of cache name to performance metrics (hits, misses). Returns:Map<String, long[]> map of cache metrics (hits, misses)

getCacheMetrics

back to summary

public Map<String, long[]> getCacheMetrics()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMetrics.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMetrics.

Get a map of cache name to performance metrics (hits, misses).

Returns:Map<String, long[]>: map of cache metrics (hits, misses)

getCacheMissRate	back to summary
public long getCacheMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMissRate. Returns:long aggregate miss rate

getCacheMissRate

back to summary

public long getCacheMissRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheMissRate.

Returns:long: aggregate miss rate

getCacheNames	back to summary
public String[] getCacheNames() throws IllegalStateException Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheNames. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheNames. Gets the cache names managed by the CacheManager

getCacheNames

back to summary

public String[] getCacheNames() throws IllegalStateException

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheNames.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheNames.

Gets the cache names managed by the CacheManager

getCacheOffHeapHitRate	back to summary
public long getCacheOffHeapHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOffHeapHitRate. Returns:long aggregate off-heap hit rate

getCacheOffHeapHitRate

back to summary

public long getCacheOffHeapHitRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOffHeapHitRate.

Returns:long: aggregate off-heap hit rate

getCacheOffHeapMissRate	back to summary
public long getCacheOffHeapMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOffHeapMissRate. Returns:long aggregate off-heap miss rate

getCacheOffHeapMissRate

back to summary

public long getCacheOffHeapMissRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOffHeapMissRate.

Returns:long: aggregate off-heap miss rate

getCacheOnDiskHitRate	back to summary
public long getCacheOnDiskHitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOnDiskHitRate. Returns:long aggregate on-disk hit rate

getCacheOnDiskHitRate

back to summary

public long getCacheOnDiskHitRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOnDiskHitRate.

Returns:long: aggregate on-disk hit rate

getCacheOnDiskMissRate	back to summary
public long getCacheOnDiskMissRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOnDiskMissRate. Returns:long aggregate on-disk miss rate

getCacheOnDiskMissRate

back to summary

public long getCacheOnDiskMissRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheOnDiskMissRate.

Returns:long: aggregate on-disk miss rate

getCachePutRate	back to summary
public long getCachePutRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCachePutRate. Returns:long aggregate put rate

getCachePutRate

back to summary

public long getCachePutRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCachePutRate.

Returns:long: aggregate put rate

getCacheRemoveRate	back to summary
public long getCacheRemoveRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheRemoveRate. Returns:long aggregate remove rate

getCacheRemoveRate

back to summary

public long getCacheRemoveRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheRemoveRate.

Returns:long: aggregate remove rate

getCacheSearchRate	back to summary
public long getCacheSearchRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheSearchRate. Returns:long aggregate search rate

getCacheSearchRate

back to summary

public long getCacheSearchRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheSearchRate.

Returns:long: aggregate search rate

getCacheUpdateRate	back to summary
public long getCacheUpdateRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheUpdateRate. Returns:long aggregate update rate

getCacheUpdateRate

back to summary

public long getCacheUpdateRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getCacheUpdateRate.

Returns:long: aggregate update rate

getClusterUUID back to summary

getClusterUUID	back to summary
public String getClusterUUID() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getClusterUUID. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getClusterUUID. Gets the cluster uuid if applicable. Returns:String the cluster uuid See Also `net.sf.ehcache.management.sampled.SampledCacheManager#getClusterUUID()`

public String getClusterUUID()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getClusterUUID.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getClusterUUID.

Gets the cluster uuid if applicable.

Returns:String: the cluster uuid
See Also: net.sf.ehcache.management.sampled.SampledCacheManager#getClusterUUID()

getHasWriteBehindWriter	back to summary
public boolean getHasWriteBehindWriter() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getHasWriteBehindWriter. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getHasWriteBehindWriter. Returns whether any caches are configured for write-behind

getHasWriteBehindWriter

back to summary

public boolean getHasWriteBehindWriter()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getHasWriteBehindWriter.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getHasWriteBehindWriter.

Returns whether any caches are configured for write-behind

getMaxBytesLocalDisk	back to summary
public long getMaxBytesLocalDisk() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDisk. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDisk. Maximum number of bytes of entries in the disk stores of all caches that did not declare their own max size. Returns:long maximum number of bytes in the disk stores of all caches that did not declare their own max size.

getMaxBytesLocalDisk

back to summary

public long getMaxBytesLocalDisk()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDisk.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDisk.

Maximum number of bytes of entries in the disk stores of all caches that did not declare their own max size.

Returns:long: maximum number of bytes in the disk stores of all caches that did not declare their own max size.

getMaxBytesLocalDiskAsString	back to summary
public String getMaxBytesLocalDiskAsString() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDiskAsString. Returns:String Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDiskAsString. Original input for maxBytesLocalDisk

getMaxBytesLocalDiskAsString

back to summary

public String getMaxBytesLocalDiskAsString()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDiskAsString.

Returns:String

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalDiskAsString.

Original input for maxBytesLocalDisk

getMaxBytesLocalHeap	back to summary
public long getMaxBytesLocalHeap() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeap. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeap. Maximum number of bytes of entries in the heap memory stores of all caches that did not declare their own max size. Returns:long maximum number of bytes in the heap memory stores of all caches that did not declare their own max size.

getMaxBytesLocalHeap

back to summary

public long getMaxBytesLocalHeap()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeap.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeap.

Maximum number of bytes of entries in the heap memory stores of all caches that did not declare their own max size.

Returns:long: maximum number of bytes in the heap memory stores of all caches that did not declare their own max size.

getMaxBytesLocalHeapAsString	back to summary
public String getMaxBytesLocalHeapAsString() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeapAsString. Returns:String Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeapAsString. Original input for maxBytesLocalHeap

getMaxBytesLocalHeapAsString

back to summary

public String getMaxBytesLocalHeapAsString()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeapAsString.

Returns:String

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalHeapAsString.

Original input for maxBytesLocalHeap

getMaxBytesLocalOffHeap	back to summary
public long getMaxBytesLocalOffHeap() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeap. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeap. Maximum number of bytes of entries in the off-heap stores of all caches that did not declare their own max size. Returns:long maximum number of bytes in the off-heap stores of all caches that did not declare their own max size.

getMaxBytesLocalOffHeap

back to summary

public long getMaxBytesLocalOffHeap()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeap.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeap.

Maximum number of bytes of entries in the off-heap stores of all caches that did not declare their own max size.

Returns:long: maximum number of bytes in the off-heap stores of all caches that did not declare their own max size.

getMaxBytesLocalOffHeapAsString	back to summary
public String getMaxBytesLocalOffHeapAsString() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeapAsString. Returns:String Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeapAsString. Original input for maxBytesLocalOffHeap

getMaxBytesLocalOffHeapAsString

back to summary

public String getMaxBytesLocalOffHeapAsString()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeapAsString.

Returns:String

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getMaxBytesLocalOffHeapAsString.

Original input for maxBytesLocalOffHeap

getMBeanRegisteredName back to summary

getMBeanRegisteredName	back to summary
public String getMBeanRegisteredName() Implements net.sf.ehcache.management.sampled.SampledCacheManagerMBean.getMBeanRegisteredName. Doc from net.sf.ehcache.management.sampled.SampledCacheManagerMBean.getMBeanRegisteredName. Gets the name used to register this mbean. See Also `net.sf.ehcache.management.sampled.SampledCacheManagerMBean#getName()`

public String getMBeanRegisteredName()

Implements net.sf.ehcache.management.sampled.SampledCacheManagerMBean.getMBeanRegisteredName.

Doc from net.sf.ehcache.management.sampled.SampledCacheManagerMBean.getMBeanRegisteredName.

Gets the name used to register this mbean.

See Also: net.sf.ehcache.management.sampled.SampledCacheManagerMBean#getName()

getName back to summary

getName	back to summary
public String getName() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getName. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getName. Gets the actual name of the cache manager. See Also `net.sf.ehcache.management.sampled.SampledCacheManager#getName()`

public String getName()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getName.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getName.

Gets the actual name of the cache manager.

See Also: net.sf.ehcache.management.sampled.SampledCacheManager#getName()

getNotificationInfo back to summary

getNotificationInfo	back to summary
public MBeanNotificationInfo[] getNotificationInfo() Implements abstract net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.getNotificationInfo. Implements javax.management.NotificationBroadcaster.getNotificationInfo. Doc from javax.management.NotificationBroadcaster.getNotificationInfo. Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type. It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning. Returns:MBeanNotificationInfo[] the array of possible notifications. Annotations @Override See Also `BaseEmitterBean#getNotificationInfo()`

public MBeanNotificationInfo[] getNotificationInfo()

Implements abstract net.sf.ehcache.hibernate.management.impl.BaseEmitterBean.getNotificationInfo.

Implements javax.management.NotificationBroadcaster.getNotificationInfo.

Doc from javax.management.NotificationBroadcaster.getNotificationInfo.

Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.

It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning.

Returns:MBeanNotificationInfo[]

the array of possible notifications.

Annotations

@Override

See Also

BaseEmitterBean#getNotificationInfo()

getSearchable	back to summary
public boolean getSearchable() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getSearchable. Returns:boolean Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getSearchable. if any contained caches are configured for search

getSearchable

back to summary

public boolean getSearchable()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getSearchable.

Returns:boolean

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getSearchable.

if any contained caches are configured for search

getStatus	back to summary
public String getStatus() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getStatus. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getStatus. Gets the status attribute of the Ehcache Returns:String The status value, as a String from the Status enum class

getStatus

back to summary

public String getStatus()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getStatus.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getStatus.

Gets the status attribute of the Ehcache

Returns:String: The status value, as a String from the Status enum class

getTransactional	back to summary
public boolean getTransactional() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactional. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactional. Are any of the caches transactional

getTransactional

back to summary

public boolean getTransactional()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactional.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactional.

Are any of the caches transactional

getTransactionCommitRate	back to summary
public long getTransactionCommitRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommitRate. Returns:long Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommitRate. aggregate Xa commit rate

getTransactionCommitRate

back to summary

public long getTransactionCommitRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommitRate.

Returns:long

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommitRate.

aggregate Xa commit rate

getTransactionCommittedCount	back to summary
public long getTransactionCommittedCount() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommittedCount. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommittedCount. Get the committed transactions count Returns:long the committed transactions count

getTransactionCommittedCount

back to summary

public long getTransactionCommittedCount()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommittedCount.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionCommittedCount.

Get the committed transactions count

Returns:long: the committed transactions count

getTransactionRollbackRate	back to summary
public long getTransactionRollbackRate() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRollbackRate. Returns:long Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRollbackRate. aggregate Xa rollback rate

getTransactionRollbackRate

back to summary

public long getTransactionRollbackRate()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRollbackRate.

Returns:long

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRollbackRate.

aggregate Xa rollback rate

getTransactionRolledBackCount	back to summary
public long getTransactionRolledBackCount() Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRolledBackCount. Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRolledBackCount. Get the rolled back transactions count Returns:long the rolled back transactions count

getTransactionRolledBackCount

back to summary

public long getTransactionRolledBackCount()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRolledBackCount.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionRolledBackCount.

Get the rolled back transactions count

Returns:long: the rolled back transactions count

getTransactionTimedOutCount

back to summary

public long getTransactionTimedOutCount()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionTimedOutCount.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getTransactionTimedOutCount.

Get the timed out transactions count. Note that only transactions which failed to commit due to a timeout are taken into account

Returns:long: the timed out transactions count

getWriterMaxQueueSize

back to summary

public int getWriterMaxQueueSize()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getWriterMaxQueueSize.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getWriterMaxQueueSize.

Maximum elements that can be queued for processing by the write-behind writer

Returns:int: aggregate of the maximum elements that can be waiting to be processed by the write-behind writer across all caches

getWriterQueueLength

back to summary

public long getWriterQueueLength()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.getWriterQueueLength.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.getWriterQueueLength.

Returns the total length of all write-behind queues across all caches

Returns:long: aggregate writer queue length

isEnabled

back to summary

public boolean isEnabled() throws CacheException

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.isEnabled.

Returns if each contained cache is enabled.

Returns:boolean

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.isEnabled.

boolean indicating that each cache is enabled

setEnabled

back to summary

public void setEnabled(boolean enabled)

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setEnabled.

Enables/disables each of the contained caches.

setMaxBytesLocalDisk	back to summary
public void setMaxBytesLocalDisk(long maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalDisk.

setMaxBytesLocalDiskAsString	back to summary
public void setMaxBytesLocalDiskAsString(String maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalDiskAsString.

setMaxBytesLocalHeap	back to summary
public void setMaxBytesLocalHeap(long maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalHeap.

setMaxBytesLocalHeapAsString	back to summary
public void setMaxBytesLocalHeapAsString(String maxBytes) Implements net.sf.ehcache.management.sampled.CacheManagerSampler.setMaxBytesLocalHeapAsString.

setMBeanRegisteredName

back to summary

pack-priv void setMBeanRegisteredName(String name)

Set the name used to register this mbean. Can be called only once. Package protected method

Parameters

name:String: the MBean name to be registered.

shutdown

back to summary

public void shutdown()

Implements net.sf.ehcache.management.sampled.CacheManagerSampler.shutdown.

Doc from net.sf.ehcache.management.sampled.CacheManagerSampler.shutdown.

Shuts down the CacheManager.

If the shutdown occurs on the singleton, then the singleton is removed, so that if a singleton access method is called, a new singleton will be created.

public Class SampledCacheManager

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail