Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.3 / shiro-ehcache / apidocs / index-all.html
blob: 03c84e64c49d9ce4aeae7fccb5eff9ca0314d4db [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_65) on Tue Feb 25 18:17:15 EST 2014 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Index (Apache Shiro :: Support :: EHCache 1.2.3 API)
</TITLE>
<META NAME="date" CONTENT="2014-02-25">
<LINK REL ="stylesheet" TYPE="text/css" HREF="./stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (Apache Shiro :: Support :: EHCache 1.2.3 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./org/apache/shiro/cache/ehcache/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./org/apache/shiro/cache/ehcache/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Index</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV&nbsp;
&nbsp;NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="./index.html?index-all.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="index-all.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="./allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="./allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<A HREF="#_C_">C</A> <A HREF="#_D_">D</A> <A HREF="#_E_">E</A> <A HREF="#_G_">G</A> <A HREF="#_I_">I</A> <A HREF="#_K_">K</A> <A HREF="#_M_">M</A> <A HREF="#_O_">O</A> <A HREF="#_P_">P</A> <A HREF="#_R_">R</A> <A HREF="#_S_">S</A> <A HREF="#_T_">T</A> <A HREF="#_V_">V</A> <HR>
<A NAME="_C_"><!-- --></A><H2>
<B>C</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#clear()"><B>clear()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Removes all elements in the cache, but leaves the cache in a useable state.
</DL>
<HR>
<A NAME="_D_"><!-- --></A><H2>
<B>D</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#destroy()"><B>destroy()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Shuts-down the wrapped Ehcache CacheManager <b>only if implicitly created</b>.
</DL>
<HR>
<A NAME="_E_"><!-- --></A><H2>
<B>E</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache"><B>EhCache</B></A>&lt;<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="type parameter in EhCache">K</A>,<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="type parameter in EhCache">V</A>&gt; - Class in <A HREF="./org/apache/shiro/cache/ehcache/package-summary.html">org.apache.shiro.cache.ehcache</A><DD>Shiro <CODE>Cache</CODE> implementation that wraps an <CODE>Ehcache</CODE> instance.<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#EhCache(net.sf.ehcache.Ehcache)"><B>EhCache(Ehcache)</B></A> -
Constructor for class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Constructs a new EhCache instance with the given cache.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache"><B>EhCacheManager</B></A> - Class in <A HREF="./org/apache/shiro/cache/ehcache/package-summary.html">org.apache.shiro.cache.ehcache</A><DD>Shiro <code>CacheManager</code> implementation utilizing the Ehcache framework for all cache functionality.<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#EhCacheManager()"><B>EhCacheManager()</B></A> -
Constructor for class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Default no argument constructor
</DL>
<HR>
<A NAME="_G_"><!-- --></A><H2>
<B>G</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#get(K)"><B>get(K)</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Gets a value of an element which matches the given key.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#getCache(java.lang.String)"><B>getCache(String)</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Loads an existing EhCache from the cache manager, or starts a new cache if one is not found.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#getCacheManager()"><B>getCacheManager()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Returns the wrapped Ehcache <CODE>CacheManager</CODE> instance.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#getCacheManagerConfigFile()"><B>getCacheManagerConfigFile()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Returns the resource location of the config file used to initialize a new
EhCache CacheManager instance.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#getCacheManagerConfigFileInputStream()"><B>getCacheManagerConfigFileInputStream()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Acquires the InputStream for the ehcache configuration file using
<CODE>ResourceUtils.getInputStreamForPath</CODE> with the
path returned from <A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#getCacheManagerConfigFile()"><CODE>getCacheManagerConfigFile()</CODE></A>.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#getDiskStoreSize()"><B>getDiskStoreSize()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Returns the size (in bytes) that this EhCache's disk store is consuming or <code>-1</code> if
that number is unknown or cannot be calculated.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#getMemoryStoreSize()"><B>getMemoryStoreSize()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Returns the size (in bytes) that this EhCache's memory store is using (RAM), or <code>-1</code> if
that number is unknown or cannot be calculated.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#getMemoryUsage()"><B>getMemoryUsage()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Returns the size (in bytes) that this EhCache is using in memory (RAM), or <code>-1</code> if that
number is unknown or cannot be calculated.
</DL>
<HR>
<A NAME="_I_"><!-- --></A><H2>
<B>I</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#init()"><B>init()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Initializes this instance.
</DL>
<HR>
<A NAME="_K_"><!-- --></A><H2>
<B>K</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#keys()"><B>keys()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>&nbsp;
</DL>
<HR>
<A NAME="_M_"><!-- --></A><H2>
<B>M</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#manager"><B>manager</B></A> -
Variable in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>The EhCache cache manager used by this implementation to create caches.
</DL>
<HR>
<A NAME="_O_"><!-- --></A><H2>
<B>O</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/package-summary.html"><B>org.apache.shiro.cache.ehcache</B></A> - package org.apache.shiro.cache.ehcache<DD><a href="http://ehcache.sourceforge.net" target="_top">Ehcache</a>-based implementations of Shiro's
cache interfaces.</DL>
<HR>
<A NAME="_P_"><!-- --></A><H2>
<B>P</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#put(K, V)"><B>put(K, V)</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Puts an object into the cache.
</DL>
<HR>
<A NAME="_R_"><!-- --></A><H2>
<B>R</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#remove(K)"><B>remove(K)</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Removes the element which matches the key.
</DL>
<HR>
<A NAME="_S_"><!-- --></A><H2>
<B>S</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#setCacheManager(net.sf.ehcache.CacheManager)"><B>setCacheManager(CacheManager)</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Sets the wrapped Ehcache <CODE>CacheManager</CODE> instance.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html#setCacheManagerConfigFile(java.lang.String)"><B>setCacheManagerConfigFile(String)</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCacheManager.html" title="class in org.apache.shiro.cache.ehcache">EhCacheManager</A>
<DD>Sets the resource location of the config file used to initialize the wrapped
EhCache CacheManager instance.
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#size()"><B>size()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>&nbsp;
</DL>
<HR>
<A NAME="_T_"><!-- --></A><H2>
<B>T</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#toString()"><B>toString()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>Returns &quot;EhCache [&quot; + cache.getName() + &quot;]&quot;
</DL>
<HR>
<A NAME="_V_"><!-- --></A><H2>
<B>V</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/cache/ehcache/EhCache.html#values()"><B>values()</B></A> -
Method in class org.apache.shiro.cache.ehcache.<A HREF="./org/apache/shiro/cache/ehcache/EhCache.html" title="class in org.apache.shiro.cache.ehcache">EhCache</A>
<DD>&nbsp;
</DL>
<HR>
<A HREF="#_C_">C</A> <A HREF="#_D_">D</A> <A HREF="#_E_">E</A> <A HREF="#_G_">G</A> <A HREF="#_I_">I</A> <A HREF="#_K_">K</A> <A HREF="#_M_">M</A> <A HREF="#_O_">O</A> <A HREF="#_P_">P</A> <A HREF="#_R_">R</A> <A HREF="#_S_">S</A> <A HREF="#_T_">T</A> <A HREF="#_V_">V</A>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./org/apache/shiro/cache/ehcache/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./org/apache/shiro/cache/ehcache/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Index</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV&nbsp;
&nbsp;NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="./index.html?index-all.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="index-all.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="./allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="./allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>