multiuserchatserviceimpl.html

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

</DL>
</DD>
</DL>
<HR>

<A NAME="processPacket(org.xmpp.packet.Packet)"><!-- --></A><H3>
processPacket</H3>
<PRE>
public void <B>processPacket</B>(<A HREF="../../../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A>&nbsp;packet)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/xmpp/component/Component.html#processPacket(org.xmpp.packet.Packet)">Component</A></CODE></B></DD>
<DD>Processes a packet sent to this Component.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/xmpp/component/Component.html#processPacket(org.xmpp.packet.Packet)">processPacket</A></CODE> in interface <CODE><A HREF="../../../../../org/xmpp/component/Component.html" title="interface in org.xmpp.component">Component</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packet</CODE> - the packet.<DT><B>See Also:</B><DD><A HREF="../../../../../org/xmpp/component/ComponentManager.html#sendPacket(org.xmpp.component.Component, org.xmpp.packet.Packet)"><CODE>ComponentManager.sendPacket(Component, Packet)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="initialize(org.xmpp.packet.JID, org.xmpp.component.ComponentManager)"><!-- --></A><H3>
initialize</H3>
<PRE>
public void <B>initialize</B>(<A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid,
                       <A HREF="../../../../../org/xmpp/component/ComponentManager.html" title="interface in org.xmpp.component">ComponentManager</A>&nbsp;componentManager)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/xmpp/component/Component.html#initialize(org.xmpp.packet.JID, org.xmpp.component.ComponentManager)">Component</A></CODE></B></DD>
<DD>Initializes this component with a ComponentManager and the JID
 that this component is available at (e.g. <tt>service.example.com</tt>). If a
 ComponentException is thrown then the component will not be loaded.<p>

 The initialization code must not rely on receiving packets from the server since
 the component has not been fully initialized yet. This means that at this point the
 component must not rely on information that is obtained from the server such us
 discovered items.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/xmpp/component/Component.html#initialize(org.xmpp.packet.JID, org.xmpp.component.ComponentManager)">initialize</A></CODE> in interface <CODE><A HREF="../../../../../org/xmpp/component/Component.html" title="interface in org.xmpp.component">Component</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the XMPP address that this component is available at.<DD><CODE>componentManager</CODE> - the component manager.</DL>
</DD>
</DL>
<HR>

<A NAME="shutdown()"><!-- --></A><H3>
shutdown</H3>
<PRE>
public void <B>shutdown</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/xmpp/component/Component.html#shutdown()">Component</A></CODE></B></DD>
<DD>Shuts down this component. All component resources must be released as
 part of shutdown.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/xmpp/component/Component.html#shutdown()">shutdown</A></CODE> in interface <CODE><A HREF="../../../../../org/xmpp/component/Component.html" title="interface in org.xmpp.component">Component</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getServiceDomain()"><!-- --></A><H3>
getServiceDomain</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>getServiceDomain</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getServiceDomain()">MultiUserChatService</A></CODE></B></DD>
<DD>Returns the fully-qualifed domain name of this chat service.
 The domain is composed by the service name and the
 name of the XMPP server where the service is running.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getServiceDomain()">getServiceDomain</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the chat server domain (service name + host name).</DL>
</DD>
</DL>
<HR>

<A NAME="getAddress()"><!-- --></A><H3>
getAddress</H3>
<PRE>
public <A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getAddress</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getChatRoom(java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
getChatRoom</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A> <B>getChatRoom</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;roomName,
                           <A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;userjid)
                    throws <A HREF="../../../../../org/jivesoftware/openfire/muc/NotAllowedException.html" title="class in org.jivesoftware.openfire.muc">NotAllowedException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getChatRoom(java.lang.String, org.xmpp.packet.JID)">MultiUserChatService</A></CODE></B></DD>
<DD>Obtains a chatroom by name. A chatroom is created for that name if none exists and the user
 has permission. The user that asked for the chatroom will be the room's owner if the chatroom
 was created.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getChatRoom(java.lang.String, org.xmpp.packet.JID)">getChatRoom</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roomName</CODE> - Name of the room to get.<DD><CODE>userjid</CODE> - The user's normal jid, not the chat nickname jid.
<DT><B>Returns:</B><DD>The chatroom for the given name.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/NotAllowedException.html" title="class in org.jivesoftware.openfire.muc">NotAllowedException</A></CODE> - If the caller doesn't have permission to create a new room.</DL>
</DD>
</DL>
<HR>

<A NAME="getChatRoom(java.lang.String)"><!-- --></A><H3>
getChatRoom</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A> <B>getChatRoom</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;roomName)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getChatRoom(java.lang.String)">MultiUserChatService</A></CODE></B></DD>
<DD>Obtains a chatroom by name. If the chatroom does not exists then null will be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getChatRoom(java.lang.String)">getChatRoom</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roomName</CODE> - Name of the room to get.
<DT><B>Returns:</B><DD>The chatroom for the given name or null if the room does not exists.</DL>
</DD>
</DL>
<HR>

<A NAME="getLocalChatRoom(java.lang.String)"><!-- --></A><H3>
getLocalChatRoom</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/openfire/muc/spi/LocalMUCRoom.html" title="class in org.jivesoftware.openfire.muc.spi">LocalMUCRoom</A> <B>getLocalChatRoom</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;roomName)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getChatRooms()"><!-- --></A><H3>
getChatRooms</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/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A>&gt; <B>getChatRooms</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getChatRooms()">MultiUserChatService</A></CODE></B></DD>
<DD>Retuns a list with a snapshot of all the rooms in the server (i.e. persistent or not,
 in memory or not).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getChatRooms()">getChatRooms</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a list with a snapshot of all the rooms.</DL>
</DD>
</DL>
<HR>

<A NAME="hasChatRoom(java.lang.String)"><!-- --></A><H3>
hasChatRoom</H3>
<PRE>
public boolean <B>hasChatRoom</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;roomName)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#hasChatRoom(java.lang.String)">MultiUserChatService</A></CODE></B></DD>
<DD>Returns true if the server includes a chatroom with the requested name.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#hasChatRoom(java.lang.String)">hasChatRoom</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roomName</CODE> - the name of the chatroom to check.
<DT><B>Returns:</B><DD>true if the server includes a chatroom with the requested name.</DL>
</DD>
</DL>
<HR>

<A NAME="removeChatRoom(java.lang.String)"><!-- --></A><H3>
removeChatRoom</H3>
<PRE>
public void <B>removeChatRoom</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;roomName)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#removeChatRoom(java.lang.String)">MultiUserChatService</A></CODE></B></DD>
<DD>Removes the room associated with the given name.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#removeChatRoom(java.lang.String)">removeChatRoom</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.mu