net.sf.ehcache.management.sampled.CacheSampler Maven / Gradle / Ivy
/**
* Copyright 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 net.sf.ehcache.statistics.LiveCacheStatistics;
import net.sf.ehcache.statistics.sampled.SampledCacheStatistics;
/**
* An interface for exposing cache statistics.
* Extends from both {@link LiveCacheStatistics} and {@link SampledCacheStatistics}
*
* @author Abhishek Sanoujam
* @author byoukste
*/
public interface CacheSampler extends LiveCacheStatistics, SampledCacheStatistics {
/**
* Is the cache enabled?
*/
boolean isEnabled();
/**
* Enabled/disable bulk-load mode for this node.
*/
void setNodeBulkLoadEnabled(boolean bulkLoadEnabled);
/**
* Is the cache in bulk-load mode cluster-wide?
*/
boolean isClusterBulkLoadEnabled();
/**
* Is the cache in bulk-load mode locally?
*/
boolean isNodeBulkLoadEnabled();
/**
* Enabled/disable the cache.
*/
void setEnabled(boolean enabled);
/**
* Removes all cached items.
*/
void removeAll();
/**
* Flushes all cache items from memory to the disk store, and from the
* DiskStore to disk.
*/
void flush();
/**
* Gets the status attribute of the Cache.
*
* @return The status value from the Status enum class
*/
String getStatus();
/**
* Is the cache configured with Terracotta clustering?
*
* @return true if clustered with terracotta
*/
boolean isTerracottaClustered();
/**
* Returns a textual description of a Terracotta-clustered cache's consistency mode.
*
* @return "STRONG", "EVENTUAL", or "na" if the cache is not Terracotta-clustered
*/
String getTerracottaConsistency();
/**
* Clear both sampled and cumulative statistics
*/
void clearStatistics();
/**
* Enables statistics collection
*/
void enableStatistics();
/**
* Disables statistics collection. Also disables sampled statistics if it is
* enabled.
*/
void disableStatistics();
/**
* Controls the statistics. Also controls sampled statistics if it is
* enabled.
*/
void setStatisticsEnabled(boolean statsEnabled);
/**
* Enables statistics collection. As it requires that normal statistics
* collection to be enabled, it enables it if its not already
*/
void enableSampledStatistics();
/**
* Disables statistics collection
*/
void disableSampledStatistics();
/**
* Configuration property accessor
*
* @return Max entries local heap config setting value
*/
long getMaxEntriesLocalHeap();
/**
* setMaxEntriesLocalHeap
*
* @param maxEntries
*/
void setMaxEntriesLocalHeap(long maxEntries);
/**
* Configuration property accessor
*
* @return Max bytes local heap config setting value
*/
long getMaxBytesLocalHeap();
/**
* setMaxBytesLocalHeap
*
* @param maxBytes
*/
void setMaxBytesLocalHeap(long maxBytes);
/**
* setMaxBytesLocalHeap
*
* @param maxBytes
*/
void setMaxBytesLocalHeapAsString(String maxBytes);
/**
* Configuration property accessor
*
* @return Max bytes local heap config setting value as string
*/
String getMaxBytesLocalHeapAsString();
/**
* Configuration property accessor
*
* @return Max bytes local offheap config setting value
*/
long getMaxBytesLocalOffHeap();
/**
* Configuration property accessor
*
* @return Max bytes local offheap config setting value as string
*/
String getMaxBytesLocalOffHeapAsString();
/**
* Configuration property accessor
*
* @return Max entries local disk config setting value
*/
long getMaxEntriesLocalDisk();
/**
* setMaxEntriesLocalDisk
*
* @param maxEntries
*/
void setMaxEntriesLocalDisk(long maxEntries);
/**
* Configuration property accessor
*
* @return Max elements on disk config setting value
*/
int getMaxElementsOnDisk();
/**
* setMaxElementsOnDisk
*
* @param maxElements
*/
void setMaxElementsOnDisk(int maxElements);
/**
* Configuration property accessor
*
* @return Max bytes local disk config setting value
*/
long getMaxBytesLocalDisk();
/**
* setMaxBytesLocalDisk
*
* @param maxBytes
*/
void setMaxBytesLocalDisk(long maxBytes);
/**
* setMaxBytesLocalDisk
*
* @param maxBytes
*/
void setMaxBytesLocalDiskAsString(String maxBytes);
/**
* Configuration property accessor
*
* @return Max bytes local disk config setting value as string
*/
String getMaxBytesLocalDiskAsString();
/**
* Configuration property accessor
*
* @return a String representation of the policy
*/
String getMemoryStoreEvictionPolicy();
/**
* setMemoryStoreEvictionPolicy
*
* @param evictionPolicy
*/
void setMemoryStoreEvictionPolicy(String evictionPolicy);
/**
* Configuration property accessor
*
* @return true if set to eternal in config
*/
boolean isEternal();
/**
* setEternal
*
* @param eternal
*/
void setEternal(boolean eternal);
/**
* Configuration property accessor
*
* @return TTI in config
*/
long getTimeToIdleSeconds();
/**
* setTimeToIdleSeconds
*
* @param tti
*/
void setTimeToIdleSeconds(long tti);
/**
* Configuration property accessor
*
* @return TTL in config
*/
long getTimeToLiveSeconds();
/**
* setTimeToLiveSeconds
*
* @param ttl
*/
void setTimeToLiveSeconds(long ttl);
/**
* Configuration property accessor
*
* @return true if overflow to disk specified in config
*/
boolean isOverflowToDisk();
/**
* setOverflowToDisk
*
* @param overflowToDisk
*/
void setOverflowToDisk(boolean overflowToDisk);
/**
* Configuration property accessor
*
* @return true if configured with disk persistence
*/
boolean isDiskPersistent();
/**
* setDiskPersistent
*
* @param diskPersistent
*/
void setDiskPersistent(boolean diskPersistent);
/**
* Configuration property accessor
*
* @return Value for disk expiry thread interval in seconds specified in config
*/
long getDiskExpiryThreadIntervalSeconds();
/**
* setDiskExpiryThreadIntervalSeconds
*
* @param seconds
*/
void setDiskExpiryThreadIntervalSeconds(long seconds);
/**
* Configuration property accessor
*
* @return true if logging is enabled on the cache
*/
boolean isLoggingEnabled();
/**
* setLoggingEnabled
*
* @param enabled
*/
void setLoggingEnabled(boolean enabled);
/**
* Configuration property accessor
*
* @return true if the cache is pinned
* @see net.sf.ehcache.config.PinningConfiguration
*/
boolean isPinned();
/**
* Configuration property accessor
*
* @return the store to which this cache is pinned
* @see net.sf.ehcache.config.PinningConfiguration
*/
String getPinnedToStore();
/**
* Is there a registered Write-behind CacheWriter
*/
boolean getHasWriteBehindWriter();
/**
* Returns the total length of all write-behind queues for this cache
*
* @return writer-behind queue length
*/
long getWriterQueueLength();
/**
* Returns the maximum size of any write-behind queues.
*
* @return Maximum elements that can be queued for processing by the write-behind writer
* @see net.sf.ehcache.config.CacheWriterConfiguration#getWriteBehindMaxQueueSize()
*/
int getWriterMaxQueueSize();
/**
* Returns the number of configured write-behind queues/threads.
*
* @return Number of configured processing queues/threads for use by the write-behind writer
* @see net.sf.ehcache.config.CacheWriterConfiguration#getWriteBehindConcurrency()
*/
int getWriterConcurrency();
/**
* Is the cache a transactional one
*
* @see net.sf.ehcache.config.CacheConfiguration.TransactionalMode
*/
boolean getTransactional();
/**
* @return Xa commit rate
*/
long getTransactionCommitRate();
/**
* @return Xa rollback rate
*/
long getTransactionRollbackRate();
/**
* Is the cache configured for search
*
* @see net.sf.ehcache.config.Searchable
*/
boolean getSearchable();
/**
* @return search rate
*/
long getCacheSearchRate();
/**
* @return search time
*/
long getCacheAverageSearchTime();
/**
* @return hit rate
*/
long getCacheHitRate();
/**
* @return in-memory hit rate
*/
long getCacheInMemoryHitRate();
/**
* @return off-heap hit rate
*/
long getCacheOffHeapHitRate();
/**
* @return on-disk hit rate
*/
long getCacheOnDiskHitRate();
/**
* @return miss rate
*/
long getCacheMissRate();
/**
* @return in-memory miss rate
*/
long getCacheInMemoryMissRate();
/**
* @return off-heap miss rate
*/
long getCacheOffHeapMissRate();
/**
* @return on-disk miss rate
*/
long getCacheOnDiskMissRate();
/**
* @return put rate
*/
long getCachePutRate();
/**
* @return update rate
*/
long getCacheUpdateRate();
/**
* @return remove rate
*/
long getCacheRemoveRate();
/**
* @return eviction rate
*/
long getCacheEvictionRate();
/**
* @return expiration rate
*/
long getCacheExpirationRate();
/**
* @return average get time (nanos.)
*/
long getCacheAverageGetTime();
}