javax.cache.management.CacheMXBean Maven / Gradle / Ivy
/**
* Copyright (c) 2011-2013 Terracotta, Inc.
* Copyright (c) 2011-2013 Oracle and/or its affiliates.
*
* All rights reserved. Use is subject to license terms.
*/
package javax.cache.management;
import javax.cache.transaction.IsolationLevel;
import javax.cache.transaction.Mode;
import javax.management.MXBean;
/**
* A management bean for cache. It provides configuration information. It does not
* allow mutation of configuration or mutation of the cache.
*
* Each cache's management object must be registered with an ObjectName that is
* unique and has the following type and attributes:
*
* Type:
* javax.cache:type=Cache
*
* Required Attributes:
*
* - CacheManager the URI of the CacheManager
*
- Cache the name of the Cache
*
*
*
* @author Greg Luck
* @author Yannis Cosmadopoulos
* @since 1.0
*/
@MXBean
public interface CacheMXBean {
/**
* Determines if a {@link javax.cache.Cache} should operate in read-through mode.
*
* When in read-through mode, cache misses that occur due to cache entries
* not existing as a result of performing a "get" call via one of
* {@link javax.cache.Cache#get(Object)},
* {@link javax.cache.Cache#getAll(java.util.Set)},
* {@link javax.cache.Cache#getAndRemove(Object)} and/or
* {@link javax.cache.Cache#getAndReplace(Object, Object)} will appropriately
* cause the configured {@link javax.cache.integration.CacheLoader} to be
* invoked.
*
* The default value is false.
*
* @return true when a {@link javax.cache.Cache} is in
* "read-through" mode.
* @see javax.cache.integration.CacheLoader
*/
boolean isReadThrough();
/**
* Determines if a {@link javax.cache.Cache} should operate in "write-through"
* mode.
*
* When in "write-through" mode, cache updates that occur as a result of
* performing "put" operations called via one of
* {@link javax.cache.Cache#put(Object, Object)},
* {@link javax.cache.Cache#getAndRemove(Object)},
* {@link javax.cache.Cache#removeAll()},
* {@link javax.cache.Cache#getAndPut(Object, Object)}
* {@link javax.cache.Cache#getAndRemove(Object)},
* {@link javax.cache.Cache#getAndReplace(Object, Object)},
* {@link javax.cache.Cache#invoke(Object,
* javax.cache.Cache.EntryProcessor, Object...)}
* {@link javax.cache.Cache#invokeAll(java.util.Set,
* javax.cache.Cache.EntryProcessor, Object...)}
*
* will appropriately cause the configured
* {@link javax.cache.integration.CacheWriter} to be invoked.
*
* The default value is false.
*
* @return true when a {@link javax.cache.Cache} is in
* "write-through" mode.
* @see javax.cache.integration.CacheWriter
*/
boolean isWriteThrough();
/**
* Whether storeByValue (true) or storeByReference (false).
* When true, both keys and values are stored by value.
*
* When false, both keys and values are stored by reference.
* Caches stored by reference are capable of mutation by any threads holding
* the reference. The effects are:
*
* - if the key is mutated, then the key may not be retrievable or
* removable
* - if the value is mutated, then all threads in the JVM can potentially
* observe those mutations,
* subject to the normal Java Memory Model rules.
*
* Storage by reference only applies to the local heap. If an entry is moved off
* heap it will
* need to be transformed into a representation. Any mutations that occur after
* transformation
* may not be reflected in the cache.
*
* When a cache is storeByValue, any mutation to the key or value does not affect
* the key of value stored in the cache.
*
* The default value is true.
*
* @return true if the cache is store by value
*/
boolean isStoreByValue();
/**
* Checks whether statistics collection is enabled in this cache.
*
* The default value is false.
*
* @return true if statistics collection is enabled
*/
boolean isStatisticsEnabled();
/**
* Checks whether management is enabled on this cache.
*
* The default value is false.
*
* @return true if management is enabled
*/
boolean isManagementEnabled();
/**
* Checks whether transactions are enabled for this cache.
*
* Note that in a transactional cache, entries being mutated within a
* transaction cannot be expired by the cache.
*
* The default value is false.
*
* @return true if transaction are enabled
*/
boolean isTransactionsEnabled();
/**
* Gets the transaction isolation level.
*
* The default value is {@link javax.cache.transaction.IsolationLevel#NONE}.
*
* @return the isolation level.
*/
IsolationLevel getTransactionIsolationLevel();
/**
* Gets the transaction mode.
*
* The default value is {@link javax.cache.transaction.Mode#NONE}.
*
* @return the mode of the cache.
*/
Mode getTransactionMode();
}