localincomingserversession.html

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

</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#getAvailableStreamFeatures()">getAvailableStreamFeatures</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a text with the available stream features.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#getLocalDomain()">getLocalDomain</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the domain or subdomain of the local server used by the remote server
 when validating the session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/String.html" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#getValidatedDomains()">getValidatedDomains</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collection with all the domains, subdomains and virtual hosts that where
 validated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#isValidDomain(java.lang.String)">isValidDomain</A></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)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the specified domain has been validated for this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#removeValidatedDomain(java.lang.String)">removeValidatedDomain</A></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)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the previously validated domain from the list of validated domains.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#setLocalDomain(java.lang.String)">setLocalDomain</A></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)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the domain or subdomain of the local server used by the remote server when asking
 to validate the session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#validateSubsequentDomain(org.dom4j.Element)">validateSubsequentDomain</A></B>(org.dom4j.Element&nbsp;dbResult)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the request of a new domain was valid.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html#verifyReceivedKey(org.dom4j.Element)">verifyReceivedKey</A></B>(org.dom4j.Element&nbsp;doc)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies the received key sent by the remote server.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.session.LocalSession"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.jivesoftware.openfire.session.<A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html" title="class in org.jivesoftware.openfire.session">LocalSession</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#close()">close</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#decodeVersion(java.lang.String)">decodeVersion</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#deliverRawText(java.lang.String)">deliverRawText</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getAddress()">getAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getConnection()">getConnection</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getCreationDate()">getCreationDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getHostAddress()">getHostAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getHostName()">getHostName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getLastActiveDate()">getLastActiveDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getNumClientPackets()">getNumClientPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getNumServerPackets()">getNumServerPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getServerName()">getServerName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getSessionData(java.lang.String)">getSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getStatus()">getStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#getStreamID()">getStreamID</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#incrementClientPacketCount()">incrementClientPacketCount</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#incrementServerPacketCount()">incrementServerPacketCount</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isClosed()">isClosed</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isSecure()">isSecure</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#isUsingSelfSignedCertificate()">isUsingSelfSignedCertificate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#process(org.xmpp.packet.Packet)">process</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#removeSessionData(java.lang.String)">removeSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setAddress(org.xmpp.packet.JID)">setAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setSessionData(java.lang.String, java.lang.Object)">setSessionData</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#setStatus(int)">setStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#toString()">toString</A>, <A HREF="../../../../org/jivesoftware/openfire/session/LocalSession.html#validate()">validate</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<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></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.session.Session"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.jivesoftware.openfire.session.<A HREF="../../../../org/jivesoftware/openfire/session/Session.html" title="interface in org.jivesoftware.openfire.session">Session</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/session/Session.html#close()">close</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#deliverRawText(java.lang.String)">deliverRawText</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getAddress()">getAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getCreationDate()">getCreationDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getHostAddress()">getHostAddress</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getHostName()">getHostName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getLastActiveDate()">getLastActiveDate</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getNumClientPackets()">getNumClientPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getNumServerPackets()">getNumServerPackets</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getServerName()">getServerName</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getStatus()">getStatus</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#getStreamID()">getStreamID</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#isClosed()">isClosed</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#isSecure()">isSecure</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#process(org.xmpp.packet.Packet)">process</A>, <A HREF="../../../../org/jivesoftware/openfire/session/Session.html#validate()">validate</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="LocalIncomingServerSession(java.lang.String, org.jivesoftware.openfire.Connection, org.jivesoftware.openfire.StreamID)"><!-- --></A><H3>
LocalIncomingServerSession</H3>
<PRE>
public <B>LocalIncomingServerSession</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;serverName,
                                  <A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;connection,
                                  <A HREF="../../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A>&nbsp;streamID)</PRE>
<DL>
</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="createSession(java.lang.String, org.dom4j.io.XMPPPacketReader, org.jivesoftware.openfire.net.SocketConnection)"><!-- --></A><H3>
createSession</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/session/LocalIncomingServerSession.html" title="class in org.jivesoftware.openfire.session">LocalIncomingServerSession</A> <B>createSession</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;serverName,
                                                       org.dom4j.io.XMPPPacketReader&nbsp;reader,
                                                       <A HREF="../../../../org/jivesoftware/openfire/net/SocketConnection.html" title="class in org.jivesoftware.openfire.net">SocketConnection</A>&nbsp;connection)
                                                throws org.xmlpull.v1.XmlPullParserException,
                                                       <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Creates a new session that will receive packets. The new session will be authenticated
 before being returned. If the authentication process fails then the answer will be
 <tt>null</tt>.<p>

 Currently the Server Dialback method is the only way to authenticate a remote server. Since
 Server Dialback requires an Authoritative Server, it is possible for this server to receive
 an incoming connection that will only exist until the requested domain has been validated.
 In this case, this method will return <tt>null</tt> since the connection is closed after
 the domain was validated. See
 <A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#createIncomingSession(org.dom4j.io.XMPPPacketReader)"><CODE>ServerDialback.createIncomingSession(org.dom4j.io.XMPPPacketReader)</CODE></A> for more
 information.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serverName</CODE> - hostname of this server.<DD><CODE>reader</CODE> - reader on the new established connection with the remote server.<DD><CODE>connection</CODE> - the new established connection with the remote server.
<DT><B>Returns:</B><DD>a new session that will receive packets or null if a problem occured while
         authenticating the remote server or when acting as the Authoritative Server during
         a Server Dialback authentication process.
<DT><B>Throws:</B>
<DD><CODE>org.xmlpull.v1.XmlPullParserException</CODE> - if an error occurs while parsing the XML.
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an input/output error occurs while using the connection.</DL>
</DD>
</DL>
<HR>

<A NAME="validateSubsequentDomain(org.dom4j.Element)"><!-- --></A><H3>
validateSubsequentDomain</H3>
<PRE>
public boolean <B>validateSubsequentDomain</B>(org.dom4j.Element&nbsp;dbResult)</PRE>
<DL>
<DD>Returns true if the request of a new domain was valid. Sessions may receive subsequent
 domain validation request. If the validation of the new domain fails then the session and
 the underlying TCP connection will be closed.<p>

 For optimization reasons, the same session may be servicing several domains of a
 remote server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dbResult</CODE> - the DOM stanza requesting the domain validation.
<DT><B>Returns:</B><DD>true if the requested domain was valid.</DL>
</DD>
</DL>
<HR>

<A NAME="isValidDomain(java.lang.String)"><!-- --></A><H3>
isValidDomain</H3>
<PRE>
public boolean <B>isValidDomain</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 true if the specified domain has been validated for this session. The remote
 server should send a "db:result" packet for registering new subdomains or even
 virtual hosts.<p>

 In the spirit of being flexible we allow remote servers to not register subdomains
 and even so consider subdomains that include the server domain in their domain part
 as valid domains.
<P>
<DD><DL>
</DL>
</DD>