cachefactory.html

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

</DD>
</DL>
<HR>

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

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

<A NAME="isSeniorClusterMember()"><!-- --></A><H3>
isSeniorClusterMember</H3>
<PRE>
public static boolean <B>isSeniorClusterMember</B>()</PRE>
<DL>
<DD>Returns true if this member is the senior member in the cluster. If clustering
 is not enabled, this method will also return true. This test is useful for
 tasks that should only be run on a single member in a cluster.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if this cluster member is the senior or if clustering is not enabled.</DL>
</DD>
</DL>
<HR>

<A NAME="getClusterNodesInfo()"><!-- --></A><H3>
getClusterNodesInfo</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterNodeInfo.html" title="interface in org.jivesoftware.openfire.cluster">ClusterNodeInfo</A>&gt; <B>getClusterNodesInfo</B>()</PRE>
<DL>
<DD>Returns basic information about the current members of the cluster or an empty
 collection if not running in a cluster.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>information about the current members of the cluster or an empty
         collection if not running in a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxClusterNodes()"><!-- --></A><H3>
getMaxClusterNodes</H3>
<PRE>
public static int <B>getMaxClusterNodes</B>()</PRE>
<DL>
<DD>Returns the maximum number of cluster members allowed. A value of 0 or 1 will
 be returned when clustering is not allowed.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the maximum number of cluster members allowed or 0 or 1 if clustering is not allowed.</DL>
</DD>
</DL>
<HR>

<A NAME="doClusterTask(org.jivesoftware.util.cache.ClusterTask)"><!-- --></A><H3>
doClusterTask</H3>
<PRE>
public static void <B>doClusterTask</B>(<A HREF="../../../../org/jivesoftware/util/cache/ClusterTask.html" title="interface in org.jivesoftware.util.cache">ClusterTask</A>&nbsp;task)</PRE>
<DL>
<DD>Invokes a task on other cluster members in an asynchronous fashion. The task will not be
 executed on the local cluster member. If clustering is not enabled, this method
 will do nothing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>task</CODE> - the task to be invoked on all other cluster members.</DL>
</DD>
</DL>
<HR>

<A NAME="doClusterTask(org.jivesoftware.util.cache.ClusterTask, byte[])"><!-- --></A><H3>
doClusterTask</H3>
<PRE>
public static void <B>doClusterTask</B>(<A HREF="../../../../org/jivesoftware/util/cache/ClusterTask.html" title="interface in org.jivesoftware.util.cache">ClusterTask</A>&nbsp;task,
                                 byte[]&nbsp;nodeID)</PRE>
<DL>
<DD>Invokes a task on a given cluster member in an asynchronous fashion. If clustering is not enabled,
 this method will do nothing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>task</CODE> - the task to be invoked on the specified cluster member.<DD><CODE>nodeID</CODE> - the byte array that identifies the target cluster member.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if requested node was not found or not running in a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="doSynchronousClusterTask(org.jivesoftware.util.cache.ClusterTask, boolean)"><!-- --></A><H3>
doSynchronousClusterTask</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<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>&gt; <B>doSynchronousClusterTask</B>(<A HREF="../../../../org/jivesoftware/util/cache/ClusterTask.html" title="interface in org.jivesoftware.util.cache">ClusterTask</A>&nbsp;task,
                                                          boolean&nbsp;includeLocalMember)</PRE>
<DL>
<DD>Invokes a task on other cluster members synchronously and returns the result as a Collection
 (method will not return until the task has been executed on each cluster member).
 The task will not be executed on the local cluster member. If clustering is not enabled,
 this method will return an empty collection.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>task</CODE> - the ClusterTask object to be invoked on all other cluster members.<DD><CODE>includeLocalMember</CODE> - true to run the task on the local member, false otherwise
<DT><B>Returns:</B><DD>collection with the result of the execution.</DL>
</DD>
</DL>
<HR>

<A NAME="doSynchronousClusterTask(org.jivesoftware.util.cache.ClusterTask, byte[])"><!-- --></A><H3>
doSynchronousClusterTask</H3>
<PRE>
public static <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> <B>doSynchronousClusterTask</B>(<A HREF="../../../../org/jivesoftware/util/cache/ClusterTask.html" title="interface in org.jivesoftware.util.cache">ClusterTask</A>&nbsp;task,
                                              byte[]&nbsp;nodeID)</PRE>
<DL>
<DD>Invokes a task on a given cluster member synchronously and returns the result of
 the remote operation. If clustering is not enabled, this method will return null.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>task</CODE> - the ClusterTask object to be invoked on a given cluster member.<DD><CODE>nodeID</CODE> - the byte array that identifies the target cluster member.
<DT><B>Returns:</B><DD>result of remote operation or null if operation failed or operation returned null.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if requested node was not found or not running in a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="initialize()"><!-- --></A><H3>
initialize</H3>
<PRE>
public static void <B>initialize</B>()
                       throws <A HREF="../../../../org/jivesoftware/util/InitializationException.html" title="class in org.jivesoftware.util">InitializationException</A></PRE>
<DL>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/InitializationException.html" title="class in org.jivesoftware.util">InitializationException</A></CODE></DL>
</DD>
</DL>
<HR>

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

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

<A NAME="joinedCluster()"><!-- --></A><H3>
joinedCluster</H3>
<PRE>
public static void <B>joinedCluster</B>()</PRE>
<DL>
<DD>Notification message indicating that this JVM has joined a cluster.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="leftCluster()"><!-- --></A><H3>
leftCluster</H3>
<PRE>
public static void <B>leftCluster</B>()</PRE>
<DL>
<DD>Notification message indicating that this JVM has left the cluster.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= 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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="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="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&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>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/jivesoftware/util/cache/Cacheable.html" title="interface in org.jivesoftware.util.cache"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/util/cache/CacheFactoryStrategy.html" title="interface in org.jivesoftware.util.cache"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/util/cache/CacheFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="CacheFactory.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>