blob: c41d21c4b17055ab3a5e32fae07cc2d97cfff8b2 [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/spi/CachingProvider.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>CachingProvider (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="CachingProvider (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/CachingProvider.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>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/spi/CachingProvider.html" target="_top">Frames</a></li>
<li><a href="CachingProvider.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.spi</div>
<h2 title="Interface CachingProvider" class="title">Interface CachingProvider</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">CachingProvider</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></pre>
<div class="block">Provides mechanisms to create, request and later manage the life-cycle of
configured <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a>s, identified by <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>s and scoped by
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>s.
<p>
The meaning and semantics of the <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> used to identify a
<a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> is implementation dependent. For applications to remain
implementation independent, they should avoid attempting to create <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>s
and instead use those returned by <a href="../../../javax/cache/spi/CachingProvider.html#getDefaultURI()"><code>getDefaultURI()</code></a>.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Brian Oliver, Greg Luck</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#close()">close</a></strong>()</code>
<div class="block">Closes all of the <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources
created and maintained by the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> across all
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#close(java.lang.ClassLoader)">close</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</code>
<div class="block">Closes all <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources created
by the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> using the specified <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#close(java.net.URI, java.lang.ClassLoader)">close</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</code>
<div class="block">Closes all <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources created
by the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> for the specified <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> and
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#getCacheManager()">getCacheManager</a></strong>()</code>
<div class="block">Requests a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> configured according to the
<a href="../../../javax/cache/spi/CachingProvider.html#getDefaultURI()"><code>getDefaultURI()</code></a> and <a href="../../../javax/cache/spi/CachingProvider.html#getDefaultProperties()"><code>getDefaultProperties()</code></a> be made
available that using the <a href="../../../javax/cache/spi/CachingProvider.html#getDefaultClassLoader()"><code>getDefaultClassLoader()</code></a> for loading
underlying classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#getCacheManager(java.net.URI, java.lang.ClassLoader)">getCacheManager</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</code>
<div class="block">Requests a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> configured according to the implementation
specific <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> that uses the provided <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> for loading
underlying classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#getCacheManager(java.net.URI, java.lang.ClassLoader, java.util.Properties)">getCacheManager</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader,
<a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</code>
<div class="block">Requests a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> configured according to the implementation
specific <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> be made available that uses the provided
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> for loading underlying classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#getDefaultClassLoader()">getDefaultClassLoader</a></strong>()</code>
<div class="block">Obtains the default <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> that will be used by the
<a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#getDefaultProperties()">getDefaultProperties</a></strong>()</code>
<div class="block">Obtains the default <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> for the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#getDefaultURI()">getDefaultURI</a></strong>()</code>
<div class="block">Obtains the default <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> for the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/cache/spi/CachingProvider.html#isSupported(javax.cache.configuration.OptionalFeature)">isSupported</a></strong>(<a href="../../../javax/cache/configuration/OptionalFeature.html" title="enum in javax.cache.configuration">OptionalFeature</a>&nbsp;optionalFeature)</code>
<div class="block">Determines whether an optional feature is supported by the
<a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</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="getCacheManager(java.net.URI, java.lang.ClassLoader, java.util.Properties)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheManager</h4>
<pre><a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a>&nbsp;getCacheManager(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader,
<a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;properties)</pre>
<div class="block">Requests a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> configured according to the implementation
specific <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> be made available that uses the provided
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> for loading underlying classes.
<p>
Multiple calls to this method with the same <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> and
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> must return the same <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instance,
except if a previously returned <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> has been closed.
<p>
Properties are used in construction of a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> and do not form
part of the identity of the CacheManager. i.e. if a second call is made to
with the same <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> and <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> but different properties,
the <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> created in the first call is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uri</code> - an implementation specific URI for the
<a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> (null means use
<a href="../../../javax/cache/spi/CachingProvider.html#getDefaultURI()"><code>getDefaultURI()</code></a>)</dd><dd><code>classLoader</code> - the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> to use for the
<a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> (null means use
<a href="../../../javax/cache/spi/CachingProvider.html#getDefaultClassLoader()"><code>getDefaultClassLoader()</code></a>)</dd><dd><code>properties</code> - the <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> for the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>
to create the <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> (null means no
implementation specific Properties are required)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></code> - when a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> for the
specified arguments could not be produced</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - when the operation could not be performed
due to the current security settings</dd></dl>
</li>
</ul>
<a name="getDefaultClassLoader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultClassLoader</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;getDefaultClassLoader()</pre>
<div class="block">Obtains the default <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> that will be used by the
<a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the default <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> used by the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a></dd></dl>
</li>
</ul>
<a name="getDefaultURI()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultURI</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;getDefaultURI()</pre>
<div class="block">Obtains the default <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> for the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.
<p>
Use this method to obtain a suitable <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> for the
<a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the default <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> for the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a></dd></dl>
</li>
</ul>
<a name="getDefaultProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultProperties</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;getDefaultProperties()</pre>
<div class="block">Obtains the default <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> for the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.
<p>
Use this method to obtain suitable <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> for the
<a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the default <a href="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> for the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a></dd></dl>
</li>
</ul>
<a name="getCacheManager(java.net.URI, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheManager</h4>
<pre><a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a>&nbsp;getCacheManager(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</pre>
<div class="block">Requests a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> configured according to the implementation
specific <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> that uses the provided <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> for loading
underlying classes.
<p>
Multiple calls to this method with the same <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> and
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> must return the same <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instance,
except if a previously returned <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> has been closed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uri</code> - an implementation specific <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> for the
<a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> (null means
use <a href="../../../javax/cache/spi/CachingProvider.html#getDefaultURI()"><code>getDefaultURI()</code></a>)</dd><dd><code>classLoader</code> - the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> to use for the
<a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> (null means
use <a href="../../../javax/cache/spi/CachingProvider.html#getDefaultClassLoader()"><code>getDefaultClassLoader()</code></a>)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/cache/CacheException.html" title="class in javax.cache">CacheException</a></code> - when a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> for the
specified arguments could not be produced</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - when the operation could not be performed
due to the current security settings</dd></dl>
</li>
</ul>
<a name="getCacheManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheManager</h4>
<pre><a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache">CacheManager</a>&nbsp;getCacheManager()</pre>
<div class="block">Requests a <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> configured according to the
<a href="../../../javax/cache/spi/CachingProvider.html#getDefaultURI()"><code>getDefaultURI()</code></a> and <a href="../../../javax/cache/spi/CachingProvider.html#getDefaultProperties()"><code>getDefaultProperties()</code></a> be made
available that using the <a href="../../../javax/cache/spi/CachingProvider.html#getDefaultClassLoader()"><code>getDefaultClassLoader()</code></a> for loading
underlying classes.
<p>
Multiple calls to this method must return the same <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a>
instance, except if a previously returned <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> has been
closed.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - when the operation could not be performed
due to the current security settings</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()</pre>
<div class="block">Closes all of the <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources
created and maintained by the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> across all
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>s.
<p>
After closing the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> will still be operational. It
may still be used for acquiring <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances, though
those will now be new.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - when the operation could not be performed
due to the current security settings</dd></dl>
</li>
</ul>
<a name="close(java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</pre>
<div class="block">Closes all <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources created
by the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> using the specified <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>.
<p>
After closing the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> will still be operational. It
may still be used for acquiring <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances, though
those will now be new for the specified <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> .</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classLoader</code> - the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> to release</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - when the operation could not be performed
due to the current security settings</dd></dl>
</li>
</ul>
<a name="close(java.net.URI, java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;uri,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</pre>
<div class="block">Closes all <a href="../../../javax/cache/CacheManager.html" title="interface in javax.cache"><code>CacheManager</code></a> instances and associated resources created
by the <a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a> for the specified <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> and
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uri</code> - the <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> to release</dd><dd><code>classLoader</code> - the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> to release</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - when the operation could not be performed
due to the current security settings</dd></dl>
</li>
</ul>
<a name="isSupported(javax.cache.configuration.OptionalFeature)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isSupported</h4>
<pre>boolean&nbsp;isSupported(<a href="../../../javax/cache/configuration/OptionalFeature.html" title="enum in javax.cache.configuration">OptionalFeature</a>&nbsp;optionalFeature)</pre>
<div class="block">Determines whether an optional feature is supported by the
<a href="../../../javax/cache/spi/CachingProvider.html" title="interface in javax.cache.spi"><code>CachingProvider</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>optionalFeature</code> - the feature to check for</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the feature is supported</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/CachingProvider.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>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/cache/spi/CachingProvider.html" target="_top">Frames</a></li>
<li><a href="CachingProvider.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>