net.sf.ehcache.management.sampled.SampledCache Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache-core Show documentation
Show all versions of ehcache-core Show documentation
This is the ehcache core module. Pair it with other modules for added functionality.
/**
* Copyright 2003-2010 Terracotta, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.sf.ehcache.management.sampled;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.HashMap;
import java.util.Map;
import javax.management.MBeanNotificationInfo;
import javax.management.NotCompliantMBeanException;
import javax.management.Notification;
import net.sf.ehcache.Ehcache;
import net.sf.ehcache.config.CacheConfiguration;
import net.sf.ehcache.config.CacheConfigurationListener;
import net.sf.ehcache.config.PinningConfiguration;
import net.sf.ehcache.config.TerracottaConfiguration.Consistency;
import net.sf.ehcache.config.TerracottaConfiguration.StorageStrategy;
import net.sf.ehcache.hibernate.management.impl.BaseEmitterBean;
import net.sf.ehcache.util.CacheTransactionHelper;
import net.sf.ehcache.writer.writebehind.WriteBehindManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An implementation of {@link SampledCacheMBean}
*
*
*
* @author Abhishek Sanoujam
* @since 1.7
*/
public class SampledCache extends BaseEmitterBean implements SampledCacheMBean, CacheConfigurationListener, PropertyChangeListener {
private static final int PERCENTAGE_DIVISOR = 100;
private static final Logger LOG = LoggerFactory.getLogger(SampledCache.class.getName());
private static final MBeanNotificationInfo[] NOTIFICATION_INFO;
private final Ehcache cache;
private final String immutableCacheName;
static {
final String[] notifTypes = new String[] {CACHE_ENABLED, CACHE_CHANGED, CACHE_FLUSHED, CACHE_STATISTICS_ENABLED,
CACHE_STATISTICS_RESET, };
final String name = Notification.class.getName();
final String description = "Ehcache SampledCache Event";
NOTIFICATION_INFO = new MBeanNotificationInfo[] {new MBeanNotificationInfo(notifTypes, name, description), };
}
/**
* Constructor accepting the backing {@link Ehcache}
*
* @param cache
*/
public SampledCache(Ehcache cache) throws NotCompliantMBeanException {
super(SampledCacheMBean.class);
this.cache = cache;
immutableCacheName = cache.getName();
cache.getCacheConfiguration().addConfigurationListener(this);
cache.addPropertyChangeListener(this);
}
/**
* Method which returns the name of the cache at construction time.
* Package protected method.
*
* @return The name of the cache
*/
String getImmutableCacheName() {
return immutableCacheName;
}
/**
* {@inheritDoc}
*/
public boolean isEnabled() {
return !cache.isDisabled();
}
/**
* {@inheritDoc}
*/
public void setEnabled(boolean enabled) {
try {
cache.setDisabled(!enabled);
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
* @deprecated use {@link #isClusterBulkLoadEnabled()} instead
*/
@Deprecated
public boolean isClusterCoherent() {
try {
return cache.isClusterCoherent();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*/
public boolean isClusterBulkLoadEnabled() {
try {
return cache.isClusterBulkLoadEnabled();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
* @deprecated use {@link #isNodeBulkLoadEnabled()} instead
*/
@Deprecated
public boolean isNodeCoherent() {
try {
return cache.isNodeCoherent();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*/
public boolean isNodeBulkLoadEnabled() {
return !isNodeCoherent();
}
/**
* {@inheritDoc}
* @deprecated use {@link #setNodeBulkLoadEnabled(boolean)} instead
*/
@Deprecated
public void setNodeCoherent(boolean coherent) {
boolean isNodeCoherent = isNodeCoherent();
if (coherent != isNodeCoherent) {
if (!coherent && getTransactional()) {
LOG.warn("a transactional cache cannot be incoherent");
return;
}
try {
cache.setNodeCoherent(coherent);
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*/
public void setNodeBulkLoadEnabled(boolean bulkLoadEnabled) {
if (bulkLoadEnabled && getTransactional()) {
LOG.warn("a transactional cache cannot be put into bulk-load mode");
return;
}
setNodeCoherent(!bulkLoadEnabled);
}
/**
* Create a standard RuntimeException from the input, if necessary.
* @param e
* @return either the original input or a new, standard RuntimeException
*/
static RuntimeException newPlainException(RuntimeException e) {
String type = e.getClass().getName();
if (type.startsWith("java.") || type.startsWith("javax.")) {
return e;
} else {
RuntimeException result = new RuntimeException(e.getMessage());
result.setStackTrace(e.getStackTrace());
return result;
}
}
/**
* {@inheritDoc}
*/
public void flush() {
try {
cache.flush();
sendNotification(CACHE_FLUSHED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*/
public String getCacheName() {
return cache.getName();
}
/**
* {@inheritDoc}
*/
public String getStatus() {
return cache.getStatus().toString();
}
/**
* {@inheritDoc}
*/
public void removeAll() {
CacheTransactionHelper.beginTransactionIfNeeded(cache);
try {
cache.removeAll();
sendNotification(CACHE_CLEARED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
} finally {
try {
CacheTransactionHelper.commitTransactionIfNeeded(cache);
} catch (RuntimeException e2) {
throw newPlainException(e2);
}
}
}
/**
* {@inheritDoc}
*/
public long getAverageGetTimeMostRecentSample() {
return cache.getSampledCacheStatistics().getAverageGetTimeMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheEvictionRate() {
return getCacheElementEvictedMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheElementEvictedMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheElementEvictedMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheExpirationRate() {
return getCacheElementExpiredMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheElementExpiredMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheElementExpiredMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCachePutRate() {
return getCacheElementPutMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheElementPutMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheElementPutMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheRemoveRate() {
return getCacheElementRemovedMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheElementRemovedMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheElementRemovedMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheUpdateRate() {
return getCacheElementUpdatedMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheElementUpdatedMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheElementUpdatedMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheInMemoryHitRate() {
return getCacheHitInMemoryMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheHitInMemoryMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheHitInMemoryMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheOffHeapHitRate() {
return getCacheHitOffHeapMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheHitOffHeapMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheHitOffHeapMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheHitRate() {
return getCacheHitMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheHitMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheHitMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheOnDiskHitRate() {
return getCacheHitOnDiskMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheHitOnDiskMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheHitOnDiskMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheMissExpiredMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheMissExpiredMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheMissRate() {
return getCacheMissMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheMissMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheMissMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheInMemoryMissRate() {
return getCacheMissInMemoryMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheMissInMemoryMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheMissInMemoryMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheOffHeapMissRate() {
return getCacheMissOffHeapMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheMissOffHeapMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheMissOffHeapMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheOnDiskMissRate() {
return getCacheMissOnDiskMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheMissOnDiskMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheMissOnDiskMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheMissNotFoundMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheMissNotFoundMostRecentSample();
}
/**
* {@inheritDoc}
*/
public int getStatisticsAccuracy() {
return cache.getSampledCacheStatistics().getStatisticsAccuracy();
}
/**
* {@inheritDoc}
*/
public String getStatisticsAccuracyDescription() {
return cache.getSampledCacheStatistics().getStatisticsAccuracyDescription();
}
/**
* {@inheritDoc}
*/
public void clearStatistics() {
try {
cache.clearStatistics();
sendNotification(CACHE_STATISTICS_RESET, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*/
public boolean isStatisticsEnabled() {
return cache.isStatisticsEnabled();
}
/**
* {@inheritDoc}
*/
public boolean isSampledStatisticsEnabled() {
return cache.getSampledCacheStatistics().isSampledStatisticsEnabled();
}
/**
* {@inheritDoc}
*/
public boolean isTerracottaClustered() {
return this.cache.getCacheConfiguration().isTerracottaClustered();
}
/**
* {@inheritDoc}
*/
public String getTerracottaConsistency() {
Consistency consistency = this.cache.getCacheConfiguration().getTerracottaConsistency();
return consistency != null ? consistency.name() : "na";
}
/**
* {@inheritDoc}
*/
public String getTerracottaStorageStrategy() {
StorageStrategy storageStrategy = this.cache.getCacheConfiguration().getTerracottaStorageStrategy();
return storageStrategy != null ? storageStrategy.name() : "na";
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#enableStatistics()
*/
public void enableStatistics() {
if (!cache.isStatisticsEnabled()) {
try {
cache.setSampledStatisticsEnabled(true);
cache.setStatisticsEnabled(true);
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#disableStatistics()
*/
public void disableStatistics() {
if (cache.isStatisticsEnabled()) {
try {
cache.setSampledStatisticsEnabled(false);
cache.setStatisticsEnabled(false);
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setStatisticsEnabled(boolean)
*/
public void setStatisticsEnabled(boolean statsEnabled) {
boolean oldValue = isStatisticsEnabled();
if (oldValue != statsEnabled) {
if (statsEnabled) {
enableStatistics();
} else {
disableStatistics();
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#enableSampledStatistics()
*/
public void enableSampledStatistics() {
if (!cache.isSampledStatisticsEnabled()) {
try {
cache.setSampledStatisticsEnabled(true);
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#disableSampledStatistics ()
*/
public void disableSampledStatistics() {
if (cache.isSampledStatisticsEnabled()) {
try {
cache.setSampledStatisticsEnabled(false);
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*/
public float getCacheAverageGetTime() {
return getAverageGetTimeMillis();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getAverageGetTimeMillis()
*/
public float getAverageGetTimeMillis() {
try {
return cache.getAverageGetTime();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.statistics.LiveCacheStatistics#getMaxGetTimeMillis()
*/
public long getMaxGetTimeMillis() {
try {
return cache.getLiveCacheStatistics().getMaxGetTimeMillis();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.statistics.LiveCacheStatistics#getXaCommitCount()
*/
public long getXaCommitCount() {
try {
return cache.getLiveCacheStatistics().getXaCommitCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.statistics.LiveCacheStatistics#getXaRollbackCount()
*/
public long getXaRollbackCount() {
try {
return cache.getLiveCacheStatistics().getXaRollbackCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*/
public boolean getHasWriteBehindWriter() {
return cache.getWriterManager() instanceof WriteBehindManager &&
cache.getRegisteredCacheWriter() != null;
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.statistics.LiveCacheStatistics#getWriterQueueLength()
*/
public long getWriterQueueLength() {
try {
return cache.getLiveCacheStatistics().getWriterQueueLength();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*/
public int getWriterMaxQueueSize() {
return cache.getCacheConfiguration().getCacheWriterConfiguration().getWriteBehindMaxQueueSize();
}
/**
* {@inheritDoc}
*/
public int getWriterConcurrency() {
return cache.getCacheConfiguration().getCacheWriterConfiguration().getWriteBehindConcurrency();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.statistics.LiveCacheStatistics#getMinGetTimeMillis()
*/
public long getMinGetTimeMillis() {
try {
return cache.getLiveCacheStatistics().getMinGetTimeMillis();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getCacheHitCount()
*/
public long getCacheHitCount() {
try {
return cache.getLiveCacheStatistics().getCacheHitCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getCacheMissCount()
*/
public long getCacheMissCount() {
try {
return cache.getLiveCacheStatistics().getCacheMissCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getInMemoryMissCount()
*/
public long getInMemoryMissCount() {
try {
return cache.getLiveCacheStatistics().getInMemoryMissCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getOffHeapMissCount()
*/
public long getOffHeapMissCount() {
try {
return cache.getLiveCacheStatistics().getOffHeapMissCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getOnDiskMissCount()
*/
public long getOnDiskMissCount() {
try {
return cache.getLiveCacheStatistics().getOnDiskMissCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getCacheMissCountExpired()
*/
public long getCacheMissCountExpired() {
try {
return cache.getLiveCacheStatistics().getCacheMissCountExpired();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getDiskExpiryThreadIntervalSeconds()
*/
public long getDiskExpiryThreadIntervalSeconds() {
return cache.getCacheConfiguration().getDiskExpiryThreadIntervalSeconds();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setDiskExpiryThreadIntervalSeconds(long)
*/
public void setDiskExpiryThreadIntervalSeconds(long seconds) {
if (getDiskExpiryThreadIntervalSeconds() != seconds) {
try {
cache.getCacheConfiguration().setDiskExpiryThreadIntervalSeconds(seconds);
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxEntriesLocalHeap()
*/
public long getMaxEntriesLocalHeap() {
return cache.getCacheConfiguration().getMaxEntriesLocalHeap();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxEntriesLocalHeap(long)
*/
public void setMaxEntriesLocalHeap(long maxEntries) {
if (getMaxEntriesLocalHeap() != maxEntries) {
try {
cache.getCacheConfiguration().setMaxEntriesLocalHeap(maxEntries);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxBytesLocalHeap()
*/
public long getMaxBytesLocalHeap() {
return cache.getCacheConfiguration().getMaxBytesLocalHeap();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxBytesLocalHeap(long)
*/
public void setMaxBytesLocalHeap(long maxBytes) {
try {
if (cache.getCacheManager().getConfiguration().isMaxBytesLocalHeapSet()) {
long heapPoolSize = cache.getCacheManager().getConfiguration().getMaxBytesLocalHeap();
if (maxBytes > heapPoolSize) {
throw new IllegalArgumentException("Requested maxBytesLocalHeap ("
+ maxBytes + ") greater than available CacheManager heap pool size ("
+ heapPoolSize + ")");
}
}
cache.getCacheConfiguration().setMaxBytesLocalHeap(Long.valueOf(maxBytes));
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxBytesLocalHeapAsString(String)
*/
public void setMaxBytesLocalHeapAsString(String maxBytes) {
try {
cache.getCacheConfiguration().setMaxBytesLocalHeap(maxBytes);
if (cache.getCacheConfiguration().isMaxBytesLocalHeapPercentageSet()) {
long cacheAssignedMem = cache.getCacheManager().getConfiguration().getMaxBytesLocalHeap() *
cache.getCacheConfiguration().getMaxBytesLocalHeapPercentage() / PERCENTAGE_DIVISOR;
setMaxBytesLocalHeap(cacheAssignedMem);
} else {
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
}
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxBytesLocalHeapAsString()
*/
public String getMaxBytesLocalHeapAsString() {
return cache.getCacheConfiguration().getMaxBytesLocalHeapAsString();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxElementsInMemory()
*/
public int getMaxElementsInMemory() {
return cache.getCacheConfiguration().getMaxElementsInMemory();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxElementsInMemory(int)
*/
public void setMaxElementsInMemory(int maxElements) {
if (getMaxElementsInMemory() != maxElements) {
try {
cache.getCacheConfiguration().setMaxElementsInMemory(maxElements);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxEntriesLocalDisk()
*/
public long getMaxEntriesLocalDisk() {
return cache.getCacheConfiguration().getMaxEntriesLocalDisk();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxEntriesLocalDisk(long)
*/
public void setMaxEntriesLocalDisk(long maxEntries) {
if (getMaxEntriesLocalDisk() != maxEntries) {
try {
cache.getCacheConfiguration().setMaxEntriesLocalDisk(maxEntries);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxBytesLocalDisk(long)
*/
public void setMaxBytesLocalDisk(long maxBytes) {
try {
if (cache.getCacheManager().getConfiguration().isMaxBytesLocalDiskSet()) {
long diskPoolSize = cache.getCacheManager().getConfiguration().getMaxBytesLocalDisk();
if (maxBytes > diskPoolSize) {
throw new IllegalArgumentException("Requested maxBytesLocalDisk ("
+ maxBytes + ") greater than available CacheManager disk pool size ("
+ diskPoolSize + ")");
}
}
cache.getCacheConfiguration().setMaxBytesLocalDisk(Long.valueOf(maxBytes));
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxBytesLocalDiskAsString(String)
*/
public void setMaxBytesLocalDiskAsString(String maxBytes) {
try {
cache.getCacheConfiguration().setMaxBytesLocalDisk(maxBytes);
if (cache.getCacheConfiguration().isMaxBytesLocalDiskPercentageSet()) {
long cacheAssignedMem = cache.getCacheManager().getConfiguration().getMaxBytesLocalDisk() *
cache.getCacheConfiguration().getMaxBytesLocalDiskPercentage() / PERCENTAGE_DIVISOR;
setMaxBytesLocalDisk(cacheAssignedMem);
} else {
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
}
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxBytesLocalDiskAsString()
*/
public String getMaxBytesLocalDiskAsString() {
return cache.getCacheConfiguration().getMaxBytesLocalDiskAsString();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxElementsOnDisk()
*/
public int getMaxElementsOnDisk() {
return cache.getCacheConfiguration().getMaxElementsOnDisk();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMaxElementsOnDisk(int)
*/
public void setMaxElementsOnDisk(int maxElements) {
if (getMaxElementsOnDisk() != maxElements) {
try {
cache.getCacheConfiguration().setMaxElementsOnDisk(maxElements);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxBytesLocalDisk()
*/
public long getMaxBytesLocalDisk() {
return cache.getCacheConfiguration().getMaxBytesLocalDisk();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxBytesLocalOffHeap()
*/
public long getMaxBytesLocalOffHeap() {
return cache.getCacheConfiguration().getMaxBytesLocalOffHeap();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMaxBytesLocalOffHeapAsString()
*/
public String getMaxBytesLocalOffHeapAsString() {
return cache.getCacheConfiguration().getMaxBytesLocalOffHeapAsString();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getMemoryStoreEvictionPolicy()
*/
public String getMemoryStoreEvictionPolicy() {
return cache.getCacheConfiguration().getMemoryStoreEvictionPolicy().toString();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setMemoryStoreEvictionPolicy(String)
*/
public void setMemoryStoreEvictionPolicy(String evictionPolicy) {
if (!getMemoryStoreEvictionPolicy().equals(evictionPolicy)) {
try {
cache.getCacheConfiguration().setMemoryStoreEvictionPolicy(evictionPolicy);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getTimeToIdleSeconds()
*/
public long getTimeToIdleSeconds() {
return cache.getCacheConfiguration().getTimeToIdleSeconds();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setTimeToIdleSeconds(long)
*/
public void setTimeToIdleSeconds(long tti) {
if (getTimeToIdleSeconds() != tti) {
try {
cache.getCacheConfiguration().setTimeToIdleSeconds(tti);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getTimeToLiveSeconds()
*/
public long getTimeToLiveSeconds() {
return cache.getCacheConfiguration().getTimeToLiveSeconds();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setTimeToLiveSeconds(long)
*/
public void setTimeToLiveSeconds(long ttl) {
if (getTimeToLiveSeconds() != ttl) {
try {
cache.getCacheConfiguration().setTimeToLiveSeconds(ttl);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#isDiskPersistent()
*/
public boolean isDiskPersistent() {
return cache.getCacheConfiguration().isDiskPersistent();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setDiskPersistent(boolean)
*/
public void setDiskPersistent(boolean diskPersistent) {
if (isDiskPersistent() != diskPersistent) {
try {
cache.getCacheConfiguration().setDiskPersistent(diskPersistent);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#isEternal()
*/
public boolean isEternal() {
return cache.getCacheConfiguration().isEternal();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setEternal(boolean)
*/
public void setEternal(boolean eternal) {
if (isEternal() != eternal) {
try {
cache.getCacheConfiguration().setEternal(eternal);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#isOverflowToDisk()
*/
public boolean isOverflowToDisk() {
return cache.getCacheConfiguration().isOverflowToDisk();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setOverflowToDisk(boolean)
*/
public void setOverflowToDisk(boolean overflowToDisk) {
if (isOverflowToDisk() != overflowToDisk) {
try {
cache.getCacheConfiguration().setOverflowToDisk(overflowToDisk);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#isLoggingEnabled()
*/
public boolean isLoggingEnabled() {
return cache.getCacheConfiguration().getLogging();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#setLoggingEnabled(boolean)
*/
public void setLoggingEnabled(boolean enabled) {
if (isLoggingEnabled() != enabled) {
try {
cache.getCacheConfiguration().setLogging(enabled);
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#isPinned()
*/
public boolean isPinned() {
return cache.getCacheConfiguration().getPinningConfiguration() != null;
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getPinnedToStore()
*/
public String getPinnedToStore() {
PinningConfiguration pinningConfig = cache.getCacheConfiguration().getPinningConfiguration();
return pinningConfig != null ? pinningConfig.getStore().name() : "na";
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getEvictedCount()
*/
public long getEvictedCount() {
try {
return cache.getLiveCacheStatistics().getEvictedCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getExpiredCount()
*/
public long getExpiredCount() {
try {
return cache.getLiveCacheStatistics().getExpiredCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getInMemoryHitCount()
*/
public long getInMemoryHitCount() {
try {
return cache.getLiveCacheStatistics().getInMemoryHitCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getInMemorySize()
* @deprecated use {@link #getLocalHeapSize()}
*/
@Deprecated
public long getInMemorySize() {
return getLocalHeapSize();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getOffHeapHitCount()
*/
public long getOffHeapHitCount() {
try {
return cache.getLiveCacheStatistics().getOffHeapHitCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getOffHeapSize()
* @deprecated use {@link #getLocalOffHeapSize()}
*/
@Deprecated
public long getOffHeapSize() {
return getLocalOffHeapSize();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getOnDiskHitCount()
*/
public long getOnDiskHitCount() {
try {
return cache.getLiveCacheStatistics().getOnDiskHitCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getOnDiskSize()
* @deprecated use {@link #getLocalDiskSize()}
*/
@Deprecated
public long getOnDiskSize() {
return getLocalDiskSize();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getLocalDiskSize()
*/
public long getLocalDiskSize() {
try {
return cache.getLiveCacheStatistics().getLocalDiskSize();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getLocalHeapSize()
*/
public long getLocalHeapSize() {
try {
return cache.getLiveCacheStatistics().getLocalHeapSize();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getLocalOffHeapSize()
*/
public long getLocalOffHeapSize() {
try {
return cache.getLiveCacheStatistics().getLocalOffHeapSize();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getLocalDiskSizeInBytes()
*/
public long getLocalDiskSizeInBytes() {
try {
return cache.getLiveCacheStatistics().getLocalDiskSizeInBytes();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
private boolean isCacheManagerPooled() {
return cache.getCacheManager().getConfiguration().isMaxBytesLocalHeapSet() ||
cache.getCacheManager().getConfiguration().isMaxBytesLocalOffHeapSet() ||
cache.getCacheManager().getConfiguration().isMaxBytesLocalDiskSet();
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getLocalHeapSizeInBytes()
*/
public long getLocalHeapSizeInBytes() {
try {
return cache.getLiveCacheStatistics().getLocalHeapSizeInBytes();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getLocalOffHeapSizeInBytes()
*/
public long getLocalOffHeapSizeInBytes() {
try {
return cache.getLiveCacheStatistics().getLocalOffHeapSizeInBytes();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getPutCount()
*/
public long getPutCount() {
try {
return cache.getLiveCacheStatistics().getPutCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getRemovedCount()
*/
public long getRemovedCount() {
try {
return cache.getLiveCacheStatistics().getRemovedCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getSize()
*/
public long getSize() {
try {
return cache.getLiveCacheStatistics().getSize();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* {@inheritDoc}
*
* @see net.sf.ehcache.management.sampled.SampledCacheMBean#getUpdateCount()
*/
public long getUpdateCount() {
try {
return cache.getLiveCacheStatistics().getUpdateCount();
} catch (RuntimeException e) {
throw newPlainException(e);
}
}
/**
* getCacheAttributes
*
* @return map of attribute name -> value
*/
public Map getCacheAttributes() {
Map result = new HashMap();
result.put("Enabled", isEnabled());
result.put("TerracottaClustered", isTerracottaClustered());
result.put("LoggingEnabled", isLoggingEnabled());
result.put("TimeToIdleSeconds", getTimeToIdleSeconds());
result.put("TimeToLiveSeconds", getTimeToLiveSeconds());
result.put("MaxEntriesLocalHeap", getMaxEntriesLocalHeap());
result.put("MaxEntriesLocalDisk", getMaxEntriesLocalDisk());
result.put("MaxBytesLocalHeapAsString", getMaxBytesLocalHeapAsString());
result.put("MaxBytesLocalOffHeapAsString", getMaxBytesLocalOffHeapAsString());
result.put("MaxBytesLocalDiskAsString", getMaxBytesLocalDiskAsString());
result.put("MaxBytesLocalHeap", getMaxBytesLocalHeap());
result.put("MaxBytesLocalOffHeap", getMaxBytesLocalOffHeap());
result.put("MaxBytesLocalDisk", getMaxBytesLocalDisk());
result.put("DiskPersistent", isDiskPersistent());
result.put("Eternal", isEternal());
result.put("OverflowToDisk", isOverflowToDisk());
result.put("DiskExpiryThreadIntervalSeconds", getDiskExpiryThreadIntervalSeconds());
result.put("MemoryStoreEvictionPolicy", getMemoryStoreEvictionPolicy());
result.put("TerracottaConsistency", getTerracottaConsistency());
if (isTerracottaClustered()) {
result.put("NodeBulkLoadEnabled", isNodeBulkLoadEnabled());
result.put("NodeCoherent", isNodeCoherent());
result.put("ClusterBulkLoadEnabled", isClusterBulkLoadEnabled());
result.put("ClusterCoherent", isClusterCoherent());
}
result.put("StatisticsEnabled", isStatisticsEnabled());
result.put("WriterConcurrency", getWriterConcurrency());
result.put("Transactional", getTransactional());
result.put("PinnedToStore", getPinnedToStore());
return result;
}
/**
* @see BaseEmitterBean#getNotificationInfo()
*/
@Override
public MBeanNotificationInfo[] getNotificationInfo() {
return NOTIFICATION_INFO;
}
/**
* {@inheritDoc}
*/
public void deregistered(CacheConfiguration config) {
/**/
}
/**
* {@inheritDoc}
*/
public void maxBytesLocalHeapChanged(final long oldValue, final long newValue) {
if (oldValue != newValue) {
setMaxBytesLocalHeap(newValue);
}
}
/**
* {@inheritDoc}
*/
public void maxBytesLocalDiskChanged(final long oldValue, final long newValue) {
if (oldValue != newValue) {
setMaxBytesLocalDisk(newValue);
}
}
/**
* {@inheritDoc}
*/
public void diskCapacityChanged(int oldCapacity, int newCapacity) {
if (oldCapacity != newCapacity) {
setMaxElementsOnDisk(newCapacity);
}
}
/**
* {@inheritDoc}
*/
public void loggingChanged(boolean oldValue, boolean newValue) {
if (oldValue != newValue) {
setLoggingEnabled(newValue);
}
}
/**
* {@inheritDoc}
*/
public void memoryCapacityChanged(int oldCapacity, int newCapacity) {
if (oldCapacity != newCapacity) {
setMaxElementsInMemory(newCapacity);
}
}
/**
* {@inheritDoc}
*/
public void registered(CacheConfiguration config) {
/**/
}
/**
* {@inheritDoc}
*/
public void timeToIdleChanged(long oldTimeToIdle, long newTimeToIdle) {
if (oldTimeToIdle != newTimeToIdle) {
setTimeToIdleSeconds(newTimeToIdle);
}
}
/**
* {@inheritDoc}
*/
public void timeToLiveChanged(long oldTimeToLive, long newTimeToLive) {
if (oldTimeToLive != newTimeToLive) {
setTimeToLiveSeconds(newTimeToLive);
}
}
/**
* @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
*/
public void propertyChange(PropertyChangeEvent evt) {
sendNotification(CACHE_CHANGED, getCacheAttributes(), getImmutableCacheName());
}
/**
* {@inheritDoc}
*/
@Override
protected void doDispose() {
cache.getCacheConfiguration().removeConfigurationListener(this);
}
/**
* {@inheritDoc}
*/
public long getAverageSearchTime() {
return cache.getAverageSearchTime();
}
/**
* {@inheritDoc}
*/
public long getSearchesPerSecond() {
return cache.getSearchesPerSecond();
}
/**
* {@inheritDoc}
*/
public boolean getTransactional() {
return cache.getCacheConfiguration().getTransactionalMode().isTransactional();
}
/**
* {@inheritDoc}
*/
public boolean getSearchable() {
return cache.getCacheConfiguration().getSearchable() != null;
}
/**
* {@inheritDoc}
*/
public long getCacheSearchRate() {
return cache.getSampledCacheStatistics().getSearchesPerSecond();
}
/**
* {@inheritDoc}
*/
public long getCacheAverageSearchTime() {
return cache.getSampledCacheStatistics().getAverageSearchTime();
}
/**
* {@inheritDoc}
*/
public long getTransactionCommitRate() {
return getCacheXaCommitsMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheXaCommitsMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheXaCommitsMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getTransactionRollbackRate() {
return getCacheXaRollbacksMostRecentSample();
}
/**
* {@inheritDoc}
*/
public long getCacheXaRollbacksMostRecentSample() {
return cache.getSampledCacheStatistics().getCacheXaRollbacksMostRecentSample();
}
}