multiuserchatmanager.html

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

getMultiUserChatService</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A> <B>getMultiUserChatService</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>&nbsp;serviceID)</PRE>
<DL>
<DD>Retrieves a MultiUserChatService instance specified by it's service ID.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serviceID</CODE> - ID of the conference service you wish to query.
<DT><B>Returns:</B><DD>The MultiUserChatService instance associated with the id, or null if none found.</DL>
</DD>
</DL>
<HR>

<A NAME="getMultiUserChatService(java.lang.String)"><!-- --></A><H3>
getMultiUserChatService</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A> <B>getMultiUserChatService</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;subdomain)</PRE>
<DL>
<DD>Retrieves a MultiUserChatService instance specified by it's subdomain of the
 server's primary domain.  In other words, if the service is conference.example.org,
 and the server is example.org, you would specify conference here.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - Subdomain of the conference service you wish to query.
<DT><B>Returns:</B><DD>The MultiUserChatService instance associated with the subdomain, or null if none found.</DL>
</DD>
</DL>
<HR>

<A NAME="getMultiUserChatService(org.xmpp.packet.JID)"><!-- --></A><H3>
getMultiUserChatService</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A> <B>getMultiUserChatService</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD>Retrieves a MultiUserChatService instance specified by any JID that refers to it.
 In other words, it can be a hostname for the service, a room JID, or even the JID
 of a occupant of the room.  Basically it takes the hostname part of the JID,
 strips off the server hostname from the end, leaving only the subdomain, and then calls
 the subdomain version of the call.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - JID that contains a reference to the conference service.
<DT><B>Returns:</B><DD>The MultiUserChatService instance associated with the JID, or null if none found.</DL>
</DD>
</DL>
<HR>

<A NAME="getMultiUserChatServices()"><!-- --></A><H3>
getMultiUserChatServices</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A>&gt; <B>getMultiUserChatServices</B>()</PRE>
<DL>
<DD>Retrieves all of the MultiUserChatServices managed and configured for this server, sorted by
 subdomain.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A list of MultiUserChatServices configured for this server.</DL>
</DD>
</DL>
<HR>

<A NAME="getMultiUserChatServicesCount()"><!-- --></A><H3>
getMultiUserChatServicesCount</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Integer.html" title="class or interface in java.lang">Integer</A> <B>getMultiUserChatServicesCount</B>()</PRE>
<DL>
<DD>Retrieves the number of MultiUserChatServices that are configured for this server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The number of registered MultiUserChatServices.</DL>
</DD>
</DL>
<HR>

<A NAME="isServiceRegistered(java.lang.String)"><!-- --></A><H3>
isServiceRegistered</H3>
<PRE>
public boolean <B>isServiceRegistered</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;subdomain)</PRE>
<DL>
<DD>Returns true if a MUC service is configured/exists for a given subdomain.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - Subdomain of service to check on.
<DT><B>Returns:</B><DD>True or false if the subdomain is registered as a MUC service.</DL>
</DD>
</DL>
<HR>

<A NAME="getMultiUserChatServiceID(java.lang.String)"><!-- --></A><H3>
getMultiUserChatServiceID</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A> <B>getMultiUserChatServiceID</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;subdomain)</PRE>
<DL>
<DD>Retrieves ID of MUC service by subdomain.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - Subdomain of service to get ID of.
<DT><B>Returns:</B><DD>ID number of MUC service, or null if none found.</DL>
</DD>
</DL>
<HR>

<A NAME="getMultiUserChatSubdomain(java.lang.Long)"><!-- --></A><H3>
getMultiUserChatSubdomain</H3>
<PRE>
public <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>getMultiUserChatSubdomain</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>&nbsp;serviceID)</PRE>
<DL>
<DD>Retrieves the subdomain of a specified service ID.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serviceID</CODE> - ID of service to get subdomain of.
<DT><B>Returns:</B><DD>Subdomain of MUC service, or null if none found.</DL>
</DD>
</DL>
<HR>

<A NAME="joinedCluster()"><!-- --></A><H3>
joinedCluster</H3>
<PRE>
public void <B>joinedCluster</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html#joinedCluster()">ClusterEventListener</A></CODE></B></DD>
<DD>Notification event indicating that this JVM is now part of a cluster. At this point the
 <A HREF="../../../../org/jivesoftware/openfire/XMPPServer.html#getNodeID()"><CODE>XMPPServer.getNodeID()</CODE></A> holds the new nodeID value.<p>

 When joining the cluster as the senior cluster member the <A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html#markedAsSeniorClusterMember()"><CODE>ClusterEventListener.markedAsSeniorClusterMember()</CODE></A>
 event will be sent right after this event.<p>

 At this point the CacheFactory holds clustered caches. That means that modifications
 to the caches will be reflected in the cluster. The clustered caches were just
 obtained from the cluster and no local cached data was automatically moved.<p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html#joinedCluster()">joinedCluster</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html" title="interface in org.jivesoftware.openfire.cluster">ClusterEventListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="joinedCluster(byte[])"><!-- --></A><H3>
joinedCluster</H3>
<PRE>
public void <B>joinedCluster</B>(byte[]&nbsp;nodeID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html#joinedCluster(byte[])">ClusterEventListener</A></CODE></B></DD>
<DD>Notification event indicating that another JVM is now part of a cluster.<p>

 At this point the CacheFactory of the new node holds clustered caches. That means
 that modifications to the caches of this JVM will be reflected in the cluster and
 in particular in the new node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html#joinedCluster(byte[])">joinedCluster</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html" title="interface in org.jivesoftware.openfire.cluster">ClusterEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeID</CODE> - ID of the node that joined the cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="leftCluster()"><!-- --></A><H3>
leftCluster</H3>
<PRE>
public void <B>leftCluster</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/cluster/ClusterEventListener.html#leftCluster()">ClusterEventListener</A></CODE></B></DD>
<DD>Notification event indicating that this JVM is no longer part of the cluster. This could
 happen when disabling clustering support, removing the enterprise plugin that provides
 clustering support or connection to cluster got lost.<p>

 Moreover, if we were in a "split brain" scenario (ie. separated cluster islands) and the
 island were this JVM belonged was marked as "old" then all nodes of that island will
 get the <tt>left cluster event</tt> and <tt>joined cluster events</tt>. That means that
 caches will be reset and thus will need to be repopulated again with fresh data from this JVM.
 This also includes the case where this JVM was the senior cluster member and when the islands
 met again then this JVM stopped being the senior member.<p>

 At this point the CacheFactory holds local caches. That means that modifications to
 the caches will only affect this JVM.
<P>