serverdialback.html

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

<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#createIncomingSession(org.dom4j.io.XMPPPacketReader)">createIncomingSession</A></B>(org.dom4j.io.XMPPPacketReader&nbsp;reader)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new <A HREF="../../../../org/jivesoftware/openfire/session/IncomingServerSession.html" title="interface in org.jivesoftware.openfire.session"><CODE>IncomingServerSession</CODE></A> with a domain validated by the Authoritative
 Server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/jivesoftware/openfire/session/LocalOutgoingServerSession.html" title="class in org.jivesoftware.openfire.session">LocalOutgoingServerSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#createOutgoingSession(java.lang.String, java.lang.String, int)">createOutgoingSession</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,
                      <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;hostname,
                      int&nbsp;port)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new connection from the Originating Server to the Receiving Server for
 authenticating the specified domain.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#isEnabled()">isEnabled</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if server dialback is enabled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#isEnabledForSelfSigned()">isEnabledForSelfSigned</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if server dialback can be used when the remote server presented a self-signed
 certificate.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#setEnabledForSelfSigned(boolean)">setEnabledForSelfSigned</A></B>(boolean&nbsp;enabled)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if server dialback can be used when the remote server presented a self-signed
 certificate.</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/server/ServerDialback.html#validateRemoteDomain(org.dom4j.Element, org.jivesoftware.openfire.StreamID)">validateRemoteDomain</A></B>(org.dom4j.Element&nbsp;doc,
                     <A HREF="../../../../org/jivesoftware/openfire/StreamID.html" title="interface in org.jivesoftware.openfire">StreamID</A>&nbsp;streamID)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the domain requested by the remote server was validated by the Authoritative
 Server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#verifyReceivedKey(org.dom4j.Element, org.jivesoftware.openfire.Connection)">verifyReceivedKey</A></B>(org.dom4j.Element&nbsp;doc,
                  <A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;connection)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies the key sent by a Receiving Server.</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#toString()" title="class or interface in java.lang">toString</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;
<P>

<!-- ============ FIELD DETAIL =========== -->

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

<A NAME="CHARSET"><!-- --></A><H3>
CHARSET</H3>
<PRE>
protected static <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>CHARSET</B></PRE>
<DL>
<DD>The utf-8 charset for decoding and encoding Jabber packet streams.
<P>
<DL>
</DL>
</DL>

<!-- ========= 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="ServerDialback(org.jivesoftware.openfire.Connection, java.lang.String)"><!-- --></A><H3>
ServerDialback</H3>
<PRE>
public <B>ServerDialback</B>(<A HREF="../../../../org/jivesoftware/openfire/Connection.html" title="interface in org.jivesoftware.openfire">Connection</A>&nbsp;connection,
                      <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)</PRE>
<DL>
<DD>Creates a new instance that will be used for creating <A HREF="../../../../org/jivesoftware/openfire/session/IncomingServerSession.html" title="interface in org.jivesoftware.openfire.session"><CODE>IncomingServerSession</CODE></A>,
 validating subsequent domains or authenticatig new domains. Use
 <A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#createIncomingSession(org.dom4j.io.XMPPPacketReader)"><CODE>createIncomingSession(org.dom4j.io.XMPPPacketReader)</CODE></A> for creating a new server
 session used for receiving packets from the remote server. Use
 <A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#validateRemoteDomain(org.dom4j.Element, org.jivesoftware.openfire.StreamID)"><CODE>validateRemoteDomain(org.dom4j.Element, org.jivesoftware.openfire.StreamID)</CODE></A> for
 validating subsequent domains and use
 <A HREF="../../../../org/jivesoftware/openfire/server/ServerDialback.html#authenticateDomain(org.jivesoftware.openfire.server.OutgoingServerSocketReader, java.lang.String, java.lang.String, java.lang.String)"><CODE>authenticateDomain(OutgoingServerSocketReader, String, String, String)</CODE></A> for
 registering new domains that are allowed to send packets to the remote server.<p>

 For validating domains a new TCP connection will be established to the Authoritative Server.
 The Authoritative Server may be the same Originating Server or some other machine in the
 Originating Server's network. Once the remote domain gets validated the Originating Server
 will be allowed for sending packets to this server. However, this server will need to
 validate its domain/s with the Originating Server if this server needs to send packets to
 the Originating Server. Another TCP connection will be established for validation this
 server domain/s and for sending packets to the Originating Server.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>connection</CODE> - the connection created by the remote server.<DD><CODE>serverName</CODE> - the name of the local server.</DL>
</DL>
<HR>

<A NAME="ServerDialback()"><!-- --></A><H3>
ServerDialback</H3>
<PRE>
public <B>ServerDialback</B>()</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="isEnabled()"><!-- --></A><H3>
isEnabled</H3>
<PRE>
public static boolean <B>isEnabled</B>()</PRE>
<DL>
<DD>Returns true if server dialback is enabled. When enabled remote servers may connect to this
 server using the server dialback method and this server may try the server dialback method
 to connect to remote servers.<p>

 When TLS is enabled between servers and server dialback method is enabled then TLS is going
 to be tried first, when connecting to a remote server, and if TLS fails then server dialback
 is going to be used as a last resort. If enabled and the remote server offered server-dialback
 after TLS and no SASL EXTERNAL then server dialback will be used.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if server dialback is enabled.</DL>
</DD>
</DL>
<HR>

<A NAME="isEnabledForSelfSigned()"><!-- --></A><H3>
isEnabledForSelfSigned</H3>
<PRE>
public static boolean <B>isEnabledForSelfSigned</B>()</PRE>
<DL>
<DD>Returns true if server dialback can be used when the remote server presented a self-signed
 certificate. During TLS the remote server can present a self-signed certificate, if this
 setting is enabled then the self-signed certificate will be accepted and if SASL EXTERNAL
 is not offered then server dialback will be used for verifying the remote server.<p>

 If self-signed certificates are accepted then server dialback over TLS is enabled.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if server dialback can be used when the remote server presented a self-signed
 certificate.</DL>
</DD>
</DL>