cachefactory.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

<PRE>
public static long <B>getMaxCacheSize</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName)</PRE>
<DL>
<DD>If a local property is found for the supplied name which specifies a value for cache size, it is returned.
 Otherwise, the defaultSize argument is returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cacheName</CODE> - the name of the cache to look up a corresponding property for.
<DT><B>Returns:</B><DD>either the property value or the default value.</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxSizeProperty(java.lang.String, long)"><!-- --></A><H3>
setMaxSizeProperty</H3>
<PRE>
public static void <B>setMaxSizeProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName,
                                      long&nbsp;size)</PRE>
<DL>
<DD>Sets a local property which overrides the maximum cache size as configured in coherence-cache-config.xml for the
 supplied cache name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cacheName</CODE> - the name of the cache to store a value for.<DD><CODE>size</CODE> - the maximum cache size.</DL>
</DD>
</DL>
<HR>

<A NAME="hasMaxSizeFromProperty(java.lang.String)"><!-- --></A><H3>
hasMaxSizeFromProperty</H3>
<PRE>
public static boolean <B>hasMaxSizeFromProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxCacheLifetime(java.lang.String)"><!-- --></A><H3>
getMaxCacheLifetime</H3>
<PRE>
public static long <B>getMaxCacheLifetime</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName)</PRE>
<DL>
<DD>If a local property is found for the supplied name which specifies a value for cache entry lifetime, it
 is returned. Otherwise, the defaultLifetime argument is returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cacheName</CODE> - the name of the cache to look up a corresponding property for.
<DT><B>Returns:</B><DD>either the property value or the default value.</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxLifetimeProperty(java.lang.String, long)"><!-- --></A><H3>
setMaxLifetimeProperty</H3>
<PRE>
public static void <B>setMaxLifetimeProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName,
                                          long&nbsp;lifetime)</PRE>
<DL>
<DD>Sets a local property which overrides the maximum cache entry lifetime as configured in coherence-cache-config.xml
 for the supplied cache name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cacheName</CODE> - the name of the cache to store a value for.<DD><CODE>lifetime</CODE> - the maximum cache entry lifetime.</DL>
</DD>
</DL>
<HR>

<A NAME="hasMaxLifetimeFromProperty(java.lang.String)"><!-- --></A><H3>
hasMaxLifetimeFromProperty</H3>
<PRE>
public static boolean <B>hasMaxLifetimeFromProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setCacheTypeProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
setCacheTypeProperty</H3>
<PRE>
public static void <B>setCacheTypeProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName,
                                        <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;type)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getCacheTypeProperty(java.lang.String)"><!-- --></A><H3>
getCacheTypeProperty</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getCacheTypeProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setMinCacheSize(java.lang.String, long)"><!-- --></A><H3>
setMinCacheSize</H3>
<PRE>
public static void <B>setMinCacheSize</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName,
                                   long&nbsp;size)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMinCacheSize(java.lang.String)"><!-- --></A><H3>
getMinCacheSize</H3>
<PRE>
public static long <B>getMinCacheSize</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;cacheName)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAllCaches()"><!-- --></A><H3>
getAllCaches</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/util/cache/Cache.html" title="interface in org.jivesoftware.util.cache">Cache</A>[] <B>getAllCaches</B>()</PRE>
<DL>
<DD>Returns an array of all caches in the system.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an array of all caches in the system.</DL>
</DD>
</DL>
<HR>

<A NAME="createCache(java.lang.String)"><!-- --></A><H3>
createCache</H3>
<PRE>
public static &lt;T extends <A HREF="../../../../org/jivesoftware/util/cache/Cache.html" title="interface in org.jivesoftware.util.cache">Cache</A>&gt; T <B>createCache</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Returns the named cache, creating it as necessary.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the cache to create.
<DT><B>Returns:</B><DD>the named cache, creating it as necessary.</DL>
</DD>
</DL>
<HR>

<A NAME="destroyCache(java.lang.String)"><!-- --></A><H3>
destroyCache</H3>
<PRE>
public static void <B>destroyCache</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Destroys the cache for the cache name specified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the cache to destroy.</DL>
</DD>
</DL>
<HR>

<A NAME="getLock(java.lang.Object, org.jivesoftware.util.cache.Cache)"><!-- --></A><H3>
getLock</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks">Lock</A> <B>getLock</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;key,
                           <A HREF="../../../../org/jivesoftware/util/cache/Cache.html" title="interface in org.jivesoftware.util.cache">Cache</A>&nbsp;cache)</PRE>
<DL>
<DD>Returns an existing <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks"><CODE>Lock</CODE></A> on the specified key or creates a new one
 if none was found. This operation is thread safe. Successive calls with the same key may or may not
 return the same <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks"><CODE>Lock</CODE></A>. However, different threads asking for the
 same Lock at the same time will get the same Lock object.<p>

 The supplied cache may or may not be used depending whether the server is running on cluster mode
 or not. When not running as part of a cluster then the lock will be unrelated to the cache and will
 only be visible in this JVM.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the object that defines the visibility or scope of the lock.<DD><CODE>cache</CODE> - the cache used for holding the lock.
<DT><B>Returns:</B><DD>an existing lock on the specified key or creates a new one if none was found.</DL>
</DD>
</DL>
<HR>

<A NAME="isClusteringAvailable()"><!-- --></A><H3>
isClusteringAvailable</H3>
<PRE>
public static boolean <B>isClusteringAvailable</B>()</PRE>
<DL>
<DD>Returns true if clustering is installed and can be used by this JVM
 to join a cluster. A false value could mean that either clustering
 support is not available or the license does not allow to have more
 than 1 cluster node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if clustering is installed and can be used by
 this JVM to join a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="isClusteringStarting()"><!-- --></A><H3>
isClusteringStarting</H3>
<PRE>
public static boolean <B>isClusteringStarting</B>()</PRE>
<DL>
<DD>Returns true is clustering is currently being started. Once the cluster
 is started or failed to be started this value will be false.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true is clustering is currently being started.</DL>
</DD>
</DL>
<HR>

<A NAME="isClusteringStarted()"><!-- --></A><H3>
isClusteringStarted</H3>
<PRE>
public static boolean <B>isClusteringStarted</B>()</PRE>
<DL>
<DD>Returns true if this node is currently a member of a cluster. The last step of application
 initialization is to join a cluster, so this method returns false during most of application startup.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if this node is currently a member of a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="getClusterMemberID()"><!-- --></A><H3>
getClusterMemberID</H3>
<PRE>
public static byte[] <B>getClusterMemberID</B>()</PRE>
<DL>
<DD>Returns a byte[] that uniquely identifies this member within the cluster or <tt>null</tt>
 when not in a cluster.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a byte[] that uniquely identifies this member within the cluster or null when not in a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="clearCaches()"><!-- --></A><H3>
clearCaches</H3>
<PRE>
public static void <B>clearCaches</B>()</PRE>
<DL>
<DD><DL>
</DL>