multiuserchatmanager.html

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

<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()</PRE>
<DL>
<DD>Called when manager starts up, to initialize things.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#start()">start</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#start()">start</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public void <B>stop</B>()</PRE>
<DL>
<DD>Called when manager is stopped, to clean things up.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#stop()">stop</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#stop()">stop</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="registerMultiUserChatService(org.jivesoftware.openfire.muc.MultiUserChatService)"><!-- --></A><H3>
registerMultiUserChatService</H3>
<PRE>
public void <B>registerMultiUserChatService</B>(<A HREF="../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A>&nbsp;service)</PRE>
<DL>
<DD>Registers a new MultiUserChatService implementation to the manager.
 This is typically used if you have a custom MUC implementation that you
 want to register with the manager.  In other words, it may not be database
 stored and may follow special rules, implementating MultiUserChatService.
 It is also used internally to register services from the database.  Triggers
 the service to start up.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - The MultiUserChatService to be registered.</DL>
</DD>
</DL>
<HR>

<A NAME="unregisterMultiUserChatService(java.lang.String)"><!-- --></A><H3>
unregisterMultiUserChatService</H3>
<PRE>
public void <B>unregisterMultiUserChatService</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>Unregisters a MultiUserChatService from the manager.  It can be used
 to explicitly unregister services, and is also used internally to unregister
 database stored services.  Triggers the service to shut down.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - The subdomain of the service to be unregistered.</DL>
</DD>
</DL>
<HR>

<A NAME="getServicesCount(boolean)"><!-- --></A><H3>
getServicesCount</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>getServicesCount</B>(boolean&nbsp;includePrivate)</PRE>
<DL>
<DD>Returns the number of registered MultiUserChatServices.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>includePrivate</CODE> - True if you want to include private/hidden services in the count.
<DT><B>Returns:</B><DD>Number of registered services.</DL>
</DD>
</DL>
<HR>

<A NAME="createMultiUserChatService(java.lang.String, java.lang.String, java.lang.Boolean)"><!-- --></A><H3>
createMultiUserChatService</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/muc/spi/MultiUserChatServiceImpl.html" title="class in org.jivesoftware.openfire.muc.spi">MultiUserChatServiceImpl</A> <B>createMultiUserChatService</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,
                                                           <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;description,
                                                           <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A>&nbsp;isHidden)
                                                    throws <A HREF="../../../../org/jivesoftware/util/AlreadyExistsException.html" title="class in org.jivesoftware.util">AlreadyExistsException</A></PRE>
<DL>
<DD>Creates a new MUC service and registers it with the manager, and starts up the service.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - Subdomain of the MUC service.<DD><CODE>description</CODE> - Description of the MUC service (can be null for default description)<DD><CODE>isHidden</CODE> - True if the service is hidden from view in services lists.
<DT><B>Returns:</B><DD>MultiUserChatService implementation that was just created.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/AlreadyExistsException.html" title="class in org.jivesoftware.util">AlreadyExistsException</A></CODE> - if the service already exists.</DL>
</DD>
</DL>
<HR>

<A NAME="updateMultiUserChatService(java.lang.Long, java.lang.String, java.lang.String)"><!-- --></A><H3>
updateMultiUserChatService</H3>
<PRE>
public void <B>updateMultiUserChatService</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,
                                       <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,
                                       <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;description)
                                throws <A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></PRE>
<DL>
<DD>Updates the configuration of a MUC service.  This is more involved than it may seem.  If the
 subdomain is changed, we need to shut down the old service and start up the new one, registering
 the new subdomain and cleaning up the old one.  Properties are tied to the ID, which will not change.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serviceID</CODE> - The ID of the service to be updated.<DD><CODE>subdomain</CODE> - New subdomain to assign to the service.<DD><CODE>description</CODE> - New description to assign to the service.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></CODE> - if service was not found.</DL>
</DD>
</DL>
<HR>

<A NAME="updateMultiUserChatService(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
updateMultiUserChatService</H3>
<PRE>
public void <B>updateMultiUserChatService</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;cursubdomain,
                                       <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;newsubdomain,
                                       <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;description)
                                throws <A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></PRE>
<DL>
<DD>Updates the configuration of a MUC service.  This is more involved than it may seem.  If the
 subdomain is changed, we need to shut down the old service and start up the new one, registering
 the new subdomain and cleaning up the old one.  Properties are tied to the ID, which will not change.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cursubdomain</CODE> - The current subdomain assigned to the service.<DD><CODE>newsubdomain</CODE> - New subdomain to assign to the service.<DD><CODE>description</CODE> - New description to assign to the service.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></CODE> - if service was not found.</DL>
</DD>
</DL>
<HR>

<A NAME="removeMultiUserChatService(java.lang.String)"><!-- --></A><H3>
removeMultiUserChatService</H3>
<PRE>
public void <B>removeMultiUserChatService</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)
                                throws <A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></PRE>
<DL>
<DD>Deletes a configured MultiUserChatService by subdomain, and shuts it down.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - The subdomain of the service to be deleted.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></CODE> - if the service was not found.</DL>
</DD>
</DL>
<HR>

<A NAME="removeMultiUserChatService(java.lang.Long)"><!-- --></A><H3>
removeMultiUserChatService</H3>
<PRE>
public void <B>removeMultiUserChatService</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)
                                throws <A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></PRE>
<DL>
<DD>Deletes a configured MultiUserChatService by ID, and shuts it down.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serviceID</CODE> - The ID opf the service to be deleted.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/NotFoundException.html" title="class in org.jivesoftware.util">NotFoundException</A></CODE> - if the service was not found.</DL>
</DD>
</DL>
<HR>

<A NAME="getMultiUserChatService(java.lang.Long)"><!-- --></A><H3>