Copyright 2011-2016 Terracotta, Inc.
Copyright 2011-2016 Oracle America Incorporated
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.
/**
* Copyright 2011-2016 Terracotta, Inc.
* Copyright 2011-2016 Oracle America Incorporated
*
* 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 javax.cache.management;
import javax.cache.Cache;
import javax.cache.integration.CacheLoader;
import javax.cache.integration.CacheWriter;
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=CacheConfiguration
Required Attributes:
- CacheManager the URI of the CacheManager
- Cache the name of the Cache
Author: Greg Luck, Yannis Cosmadopoulos Since: 1.0
/**
* A management bean for cache. It provides configuration information. It does not
* allow mutation of configuration or mutation of the cache.
* <p>
* Each cache's management object must be registered with an ObjectName that is
* unique and has the following type and attributes:
* <p>
* Type:
* <code>javax.cache:type=CacheConfiguration</code>
* <p>
* Required Attributes:
* <ul>
* <li>CacheManager the URI of the CacheManager
* <li>Cache the name of the Cache
* </ul>
*
* @author Greg Luck
* @author Yannis Cosmadopoulos
* @since 1.0
*/
@MXBean
public interface CacheMXBean {
Determines the required type of keys for this Cache, if any. Returns: the fully qualified class name of the key type,
or "java.lang.Object" if the type is undefined.
/**
* Determines the required type of keys for this {@link Cache}, if any.
*
* @return the fully qualified class name of the key type,
* or "java.lang.Object" if the type is undefined.
*/
String getKeyType();
Determines the required type of values for this Cache, if any. Returns: the fully qualified class name of the value type,
or "java.lang.Object" if the type is undefined.
/**
* Determines the required type of values for this {@link Cache}, if any.
* @return the fully qualified class name of the value type,
* or "java.lang.Object" if the type is undefined.
*/
String getValueType();
Determines if a 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 Cache.get, Cache.getAll, Cache.getAndRemove and/or Cache.getAndReplace will appropriately cause the configured CacheLoader to be invoked.
The default value is false.
See Also: Returns: true when a Cache is in "read-through" mode.
/**
* Determines if a {@link Cache} should operate in read-through mode.
* <p>
* 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 Cache#get},
* {@link Cache#getAll},
* {@link Cache#getAndRemove} and/or
* {@link Cache#getAndReplace} will appropriately
* cause the configured {@link CacheLoader} to be
* invoked.
* <p>
* The default value is <code>false</code>.
*
* @return <code>true</code> when a {@link Cache} is in
* "read-through" mode.
* @see CacheLoader
*/
boolean isReadThrough();
Determines if a 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 Cache.put, Cache.getAndRemove, Cache.removeAll, Cache.getAndPut Cache.getAndRemove, Cache.getAndReplace, Cache.invoke Cache.invokeAll
will appropriately cause the configured CacheWriter to be invoked.
The default value is false.
See Also: Returns: true when a Cache is in "write-through" mode.
/**
* Determines if a {@link Cache} should operate in "write-through"
* mode.
* <p>
* When in "write-through" mode, cache updates that occur as a result of
* performing "put" operations called via one of
* {@link Cache#put},
* {@link Cache#getAndRemove},
* {@link Cache#removeAll},
* {@link Cache#getAndPut}
* {@link Cache#getAndRemove},
* {@link Cache#getAndReplace},
* {@link Cache#invoke}
* {@link Cache#invokeAll}
* <p>
* will appropriately cause the configured {@link CacheWriter} to be invoked.
* <p>
* The default value is <code>false</code>.
*
* @return <code>true</code> when a {@link Cache} is in "write-through" mode.
* @see 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.
Returns: true if the cache is store by value
/**
* Whether storeByValue (true) or storeByReference (false).
* When true, both keys and values are stored by value.
* <p>
* 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:
* <ul>
* <li>if the key is mutated, then the key may not be retrievable or
* removable</li>
* <li>if the value is mutated, then all threads in the JVM can potentially
* observe those mutations, subject to the normal Java Memory Model rules.</li>
* </ul>
* 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.
* <p>
* When a cache is storeByValue, any mutation to the key or value does not affect
* the key of value stored in the cache.
* <p>
* The default value is <code>true</code>.
*
* @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.
Returns: true if statistics collection is enabled
/**
* Checks whether statistics collection is enabled in this cache.
* <p>
* The default value is <code>false</code>.
*
* @return true if statistics collection is enabled
*/
boolean isStatisticsEnabled();
Checks whether management is enabled on this cache.
The default value is false.
Returns: true if management is enabled
/**
* Checks whether management is enabled on this cache.
* <p>
* The default value is <code>false</code>.
*
* @return true if management is enabled
*/
boolean isManagementEnabled();
}