blob: 102547f90606d59a87facca24d1e35147eb4cb92 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<link rel="canonical" href="https://ignite.apache.org/jcache/1.0.0/javadoc/javax/cache/management/CacheMXBean.html" />
<!-- Generated by javadoc (version 1.7.0_25) on Fri Mar 28 13:34:25 EST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CacheMXBean (JSR107 API and SPI 1.0.0 API)</title>
<meta name="date" content="2014-03-28">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CacheMXBean (JSR107 API and SPI 1.0.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CacheMXBean.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/management/CacheMXBean.html" target="_top">Frames</a></li>
<li><a href="CacheMXBean.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.cache.management</div>
<h2 title="Interface CacheMXBean" class="title">Interface CacheMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="http://download.oracle.com/javase/6/docs/api/javax/management/MXBean.html?is-external=true" title="class or interface in javax.management">@MXBean</a>
public interface <span class="strong">CacheMXBean</span></pre>
<div class="block">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></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Greg Luck, Yannis Cosmadopoulos</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/management/CacheMXBean.html#getKeyType()">getKeyType</a></strong>()</code>
<div class="block">Determines the required type of keys for this <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>, if any.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/management/CacheMXBean.html#getValueType()">getValueType</a></strong>()</code>
<div class="block">Determines the required type of values for this <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>, if any.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/management/CacheMXBean.html#isManagementEnabled()">isManagementEnabled</a></strong>()</code>
<div class="block">Checks whether management is enabled on this cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/management/CacheMXBean.html#isReadThrough()">isReadThrough</a></strong>()</code>
<div class="block">Determines if a <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> should operate in read-through mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/management/CacheMXBean.html#isStatisticsEnabled()">isStatisticsEnabled</a></strong>()</code>
<div class="block">Checks whether statistics collection is enabled in this cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/management/CacheMXBean.html#isStoreByValue()">isStoreByValue</a></strong>()</code>
<div class="block">Whether storeByValue (true) or storeByReference (false).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/management/CacheMXBean.html#isWriteThrough()">isWriteThrough</a></strong>()</code>
<div class="block">Determines if a <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> should operate in "write-through"
mode.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getKeyType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyType</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getKeyType()</pre>
<div class="block">Determines the required type of keys for this <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>, if any.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the fully qualified class name of the key type,
or "java.lang.Object" if the type is undefined.</dd></dl>
</li>
</ul>
<a name="getValueType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getValueType()</pre>
<div class="block">Determines the required type of values for this <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a>, if any.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the fully qualified class name of the value type,
or "java.lang.Object" if the type is undefined.</dd></dl>
</li>
</ul>
<a name="isReadThrough()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadThrough</h4>
<pre>boolean&nbsp;isReadThrough()</pre>
<div class="block">Determines if a <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> 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
<a href="../../../javax/cache/Cache.html#get(K)"><code>Cache.get(K)</code></a>,
<a href="../../../javax/cache/Cache.html#getAll(java.util.Set)"><code>Cache.getAll(java.util.Set&lt;? extends K&gt;)</code></a>,
<a href="../../../javax/cache/Cache.html#getAndRemove(K)"><code>Cache.getAndRemove(K)</code></a> and/or
<a href="../../../javax/cache/Cache.html#getAndReplace(K, V)"><code>Cache.getAndReplace(K, V)</code></a> will appropriately
cause the configured <a href="../../../javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a> to be
invoked.
<p>
The default value is <code>false</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> when a <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> is in
"read-through" mode.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/integration/CacheLoader.html" title="interface in javax.cache.integration"><code>CacheLoader</code></a></dd></dl>
</li>
</ul>
<a name="isWriteThrough()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriteThrough</h4>
<pre>boolean&nbsp;isWriteThrough()</pre>
<div class="block">Determines if a <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> 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
<a href="../../../javax/cache/Cache.html#put(K, V)"><code>Cache.put(K, V)</code></a>,
<a href="../../../javax/cache/Cache.html#getAndRemove(K)"><code>Cache.getAndRemove(K)</code></a>,
<a href="../../../javax/cache/Cache.html#removeAll(java.util.Set)"><code>Cache.removeAll(java.util.Set&lt;? extends K&gt;)</code></a>,
<a href="../../../javax/cache/Cache.html#getAndPut(K, V)"><code>Cache.getAndPut(K, V)</code></a>
<a href="../../../javax/cache/Cache.html#getAndRemove(K)"><code>Cache.getAndRemove(K)</code></a>,
<a href="../../../javax/cache/Cache.html#getAndReplace(K, V)"><code>Cache.getAndReplace(K, V)</code></a>,
<a href="../../../javax/cache/Cache.html#invoke(K, javax.cache.processor.EntryProcessor, java.lang.Object...)"><code>Cache.invoke(K, javax.cache.processor.EntryProcessor&lt;K, V, T&gt;, java.lang.Object...)</code></a>
<a href="../../../javax/cache/Cache.html#invokeAll(java.util.Set, javax.cache.processor.EntryProcessor, java.lang.Object...)"><code>Cache.invokeAll(java.util.Set&lt;? extends K&gt;, javax.cache.processor.EntryProcessor&lt;K, V, T&gt;, java.lang.Object...)</code></a>
<p>
will appropriately cause the configured <a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><code>CacheWriter</code></a> to be invoked.
<p>
The default value is <code>false</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> when a <a href="../../../javax/cache/Cache.html" title="interface in javax.cache"><code>Cache</code></a> is in "write-through" mode.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/cache/integration/CacheWriter.html" title="interface in javax.cache.integration"><code>CacheWriter</code></a></dd></dl>
</li>
</ul>
<a name="isStoreByValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStoreByValue</h4>
<pre>boolean&nbsp;isStoreByValue()</pre>
<div class="block">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>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the cache is store by value</dd></dl>
</li>
</ul>
<a name="isStatisticsEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStatisticsEnabled</h4>
<pre>boolean&nbsp;isStatisticsEnabled()</pre>
<div class="block">Checks whether statistics collection is enabled in this cache.
<p>
The default value is <code>false</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if statistics collection is enabled</dd></dl>
</li>
</ul>
<a name="isManagementEnabled()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isManagementEnabled</h4>
<pre>boolean&nbsp;isManagementEnabled()</pre>
<div class="block">Checks whether management is enabled on this cache.
<p>
The default value is <code>false</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if management is enabled</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CacheMXBean.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../javax/cache/management/CacheStatisticsMXBean.html" title="interface in javax.cache.management"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/management/CacheMXBean.html" target="_top">Frames</a></li>
<li><a href="CacheMXBean.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2014. All Rights Reserved.</small></p>
</body>
</html>