sessionmanager.html

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

<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="getInstance()"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../../org/jivesoftware/openfire/SessionManager.html" title="class in org.jivesoftware.openfire">SessionManager</A> <B>getInstance</B>()</PRE>
<DL>
<DD>Returns the instance of <CODE>SessionManagerImpl</CODE> being used by the XMPPServer.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the instance of <CODE>SessionManagerImpl</CODE> being used by the XMPPServer.</DL>
</DD>
</DL>
<HR>

<A NAME="getConnectionMultiplexerSession(org.xmpp.packet.JID)"><!-- --></A><H3>
getConnectionMultiplexerSession</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/session/ConnectionMultiplexerSession.html" title="interface in org.jivesoftware.openfire.session">ConnectionMultiplexerSession</A> <B>getConnectionMultiplexerSession</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;address)</PRE>
<DL>
<DD>Returns the session originated from the specified address or <tt>null</tt> if none was
 found. The specified address MUST contain a resource that uniquely identifies the session.

 A single connection manager should connect to the same node.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>address</CODE> - the address of the connection manager (including resource that identifies specific socket)
<DT><B>Returns:</B><DD>the session originated from the specified address.</DL>
</DD>
</DL>
<HR>

<A NAME="getConnectionMultiplexerSessions()"><!-- --></A><H3>
getConnectionMultiplexerSessions</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/session/ConnectionMultiplexerSession.html" title="interface in org.jivesoftware.openfire.session">ConnectionMultiplexerSession</A>&gt; <B>getConnectionMultiplexerSessions</B>()</PRE>
<DL>
<DD>Returns all sessions originated from connection managers.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>all sessions originated from connection managers.</DL>
</DD>
</DL>
<HR>

<A NAME="getConnectionMultiplexerSessions(java.lang.String)"><!-- --></A><H3>
getConnectionMultiplexerSessions</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/session/ConnectionMultiplexerSession.html" title="interface in org.jivesoftware.openfire.session">ConnectionMultiplexerSession</A>&gt; <B>getConnectionMultiplexerSessions</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;domain)</PRE>
<DL>
<DD>Returns a collection with all the sessions originated from the connection manager
 whose domain matches the specified domain. If there is no connection manager with
 the specified domain then an empty list is going to be returned.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>domain</CODE> - the domain of the connection manager.
<DT><B>Returns:</B><DD>a collection with all the sessions originated from the connection manager
         whose domain matches the specified domain.</DL>
</DD>
</DL>
<HR>

<A NAME="createMultiplexerSession(org.jivesoftware.openfire.Connection, org.xmpp.packet.JID)"><!-- --></A><H3>
createMultiplexerSession</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/session/LocalConnectionMultiplexerSession.html" title="class in org.jivesoftware.openfire.session">LocalConnectionMultiplexerSession</A> <B>createMultiplexerSession</B>(<A HREF="../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;conn,
                                                                  <A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;address)</PRE>
<DL>
<DD>Creates a new <tt>ConnectionMultiplexerSession</tt>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the connection to create the session from.<DD><CODE>address</CODE> - the JID (may include a resource) of the connection manager's session.
<DT><B>Returns:</B><DD>a newly created session.</DL>
</DD>
</DL>
<HR>

<A NAME="nextStreamID()"><!-- --></A><H3>
nextStreamID</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A> <B>nextStreamID</B>()</PRE>
<DL>
<DD>Returns a randomly created ID to be used in a stream element.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a randomly created ID to be used in a stream element.</DL>
</DD>
</DL>
<HR>

<A NAME="createClientSession(org.jivesoftware.openfire.Connection)"><!-- --></A><H3>
createClientSession</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/session/LocalClientSession.html" title="class in org.jivesoftware.openfire.session">LocalClientSession</A> <B>createClientSession</B>(<A HREF="../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;conn)</PRE>
<DL>
<DD>Creates a new <tt>ClientSession</tt>. The new Client session will have a newly created
 stream ID.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the connection to create the session from.
<DT><B>Returns:</B><DD>a newly created session.</DL>
</DD>
</DL>
<HR>

<A NAME="createClientSession(org.jivesoftware.openfire.Connection, org.jivesoftware.openfire.StreamID)"><!-- --></A><H3>
createClientSession</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/session/LocalClientSession.html" title="class in org.jivesoftware.openfire.session">LocalClientSession</A> <B>createClientSession</B>(<A HREF="../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;conn,
                                              <A HREF="../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A>&nbsp;id)</PRE>
<DL>
<DD>Creates a new <tt>ClientSession</tt> with the specified streamID.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the connection to create the session from.<DD><CODE>id</CODE> - the streamID to use for the new session.
<DT><B>Returns:</B><DD>a newly created session.</DL>
</DD>
</DL>
<HR>

<A NAME="createClientHttpSession(long, java.net.InetAddress, org.jivesoftware.openfire.StreamID, org.jivesoftware.openfire.http.HttpConnection)"><!-- --></A><H3>
createClientHttpSession</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/http/HttpSession.html" title="class in org.jivesoftware.openfire.http">HttpSession</A> <B>createClientHttpSession</B>(long&nbsp;rid,
                                           <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A>&nbsp;address,
                                           <A HREF="../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A>&nbsp;id,
                                           <A HREF="../../../org/jivesoftware/openfire/http/HttpConnection.html" title="class in org.jivesoftware.openfire.http">HttpConnection</A>&nbsp;connection)
                                    throws <A HREF="../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

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

<A NAME="createComponentSession(org.xmpp.packet.JID, org.jivesoftware.openfire.Connection)"><!-- --></A><H3>
createComponentSession</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/session/LocalComponentSession.html" title="class in org.jivesoftware.openfire.session">LocalComponentSession</A> <B>createComponentSession</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;address,
                                                    <A HREF="../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;conn)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createIncomingServerSession(org.jivesoftware.openfire.Connection, org.jivesoftware.openfire.StreamID)"><!-- --></A><H3>
createIncomingServerSession</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html" title="class in org.jivesoftware.openfire.session">LocalIncomingServerSession</A> <B>createIncomingServerSession</B>(<A HREF="../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;conn,
                                                              <A HREF="../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A>&nbsp;id)
                                                       throws <A HREF="../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></PRE>
<DL>
<DD>Creates a session for a remote server. The session should be created only after the
 remote server has been authenticated either using "server dialback" or SASL.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the connection to the remote server.<DD><CODE>id</CODE> - the stream ID used in the stream element when authenticating the server.
<DT><B>Returns:</B><DD>the newly created <A HREF="../../../org/jivesoftware/openfire/session/IncomingServerSession.html" title="interface in org.jivesoftware.openfire.session"><CODE>IncomingServerSession</CODE></A>.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/jivesoftware/openfire/auth/UnauthorizedException.htm