connectionmanager.html

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

<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/jivesoftware/openfire/ConnectionManager.html#isClientSSLListenerEnabled()">isClientSSLListenerEnabled</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the port listener for secured clients is available.</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/ConnectionManager.html#isComponentListenerEnabled()">isComponentListenerEnabled</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the port listener for external components is available.</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/ConnectionManager.html#isConnectionManagerListenerEnabled()">isConnectionManagerListenerEnabled</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the port listener for connection managers is available.</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/ConnectionManager.html#isServerListenerEnabled()">isServerListenerEnabled</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the port listener for remote servers is available.</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/ConnectionManager.html#setClientListenerPort(int)">setClientListenerPort</A></B>(int&nbsp;port)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the port to use for unsecured clients.</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/ConnectionManager.html#setClientSSLListenerPort(int)">setClientSSLListenerPort</A></B>(int&nbsp;port)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the port to use for secured clients.</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/ConnectionManager.html#setComponentListenerPort(int)">setComponentListenerPort</A></B>(int&nbsp;port)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the port to use for external components.</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/ConnectionManager.html#setConnectionManagerListenerPort(int)">setConnectionManagerListenerPort</A></B>(int&nbsp;port)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the port to use for connection managers.</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/ConnectionManager.html#setServerListenerPort(int)">setServerListenerPort</A></B>(int&nbsp;port)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the port to use for remote servers.</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="DEFAULT_PORT"><!-- --></A><H3>
DEFAULT_PORT</H3>
<PRE>
static final int <B>DEFAULT_PORT</B></PRE>
<DL>
<DD>The default XMPP port for clients. This port can be used with secured
 and unsecured connections. Clients will initially connect using an unsecure
 connection and may secure it by using StartTLS.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jivesoftware.openfire.ConnectionManager.DEFAULT_PORT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DEFAULT_SSL_PORT"><!-- --></A><H3>
DEFAULT_SSL_PORT</H3>
<PRE>
static final int <B>DEFAULT_SSL_PORT</B></PRE>
<DL>
<DD>The default legacy Jabber port for SSL traffic. This old method, and soon
 to be deprecated, uses encrypted connections as soon as they are created.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jivesoftware.openfire.ConnectionManager.DEFAULT_SSL_PORT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DEFAULT_COMPONENT_PORT"><!-- --></A><H3>
DEFAULT_COMPONENT_PORT</H3>
<PRE>
static final int <B>DEFAULT_COMPONENT_PORT</B></PRE>
<DL>
<DD>The default XMPP port for external components.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jivesoftware.openfire.ConnectionManager.DEFAULT_COMPONENT_PORT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DEFAULT_SERVER_PORT"><!-- --></A><H3>
DEFAULT_SERVER_PORT</H3>
<PRE>
static final int <B>DEFAULT_SERVER_PORT</B></PRE>
<DL>
<DD>The default XMPP port for server2server communication.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jivesoftware.openfire.ConnectionManager.DEFAULT_SERVER_PORT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DEFAULT_MULTIPLEX_PORT"><!-- --></A><H3>
DEFAULT_MULTIPLEX_PORT</H3>
<PRE>
static final int <B>DEFAULT_MULTIPLEX_PORT</B></PRE>
<DL>
<DD>The default XMPP port for connection multiplex.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jivesoftware.openfire.ConnectionManager.DEFAULT_MULTIPLEX_PORT">Constant Field Values</A></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="getPorts()"><!-- --></A><H3>
getPorts</H3>
<PRE>
<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="../../../org/jivesoftware/openfire/ServerPort.html" title="class in org.jivesoftware.openfire">ServerPort</A>&gt; <B>getPorts</B>()</PRE>
<DL>
<DD>Returns an array of the ports managed by this connection manager.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an iterator of the ports managed by this connection manager
      (can be an empty but never null).</DL>
</DD>
</DL>
<HR>

<A NAME="createSocketReader(java.net.Socket, boolean, org.jivesoftware.openfire.ServerPort, boolean)"><!-- --></A><H3>
createSocketReader</H3>
<PRE>
<A HREF="../../../org/jivesoftware/openfire/net/SocketReader.html" title="class in org.jivesoftware.openfire.net">SocketReader</A> <B>createSocketReader</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/Socket.html" title="class or interface in java.net">Socket</A>&nbsp;socket,
                                boolean&nbsp;isSecure,
                                <A HREF="../../../org/jivesoftware/openfire/ServerPort.html" title="class in org.jivesoftware.openfire">ServerPort</A>&nbsp;serverPort,
                                boolean&nbsp;useBlockingMode)
                                throws <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 socket reader for the new accepted socket to be managed
 by the connection manager.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>socket</CODE> - the new accepted socket by this manager.<DD><CODE>isSecure</CODE> - true if the connection is secure.<DD><CODE>serverPort</CODE> - holds information about the port on which the server is listening for
        connections.<DD><CODE>useBlockingMode</CODE> - true means that the server will use a thread per connection.
<DT><B>Returns:</B><DD>the created socket reader.
<DT><B>Throws:</B>
<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> - when there is an error creating the socket reader.</DL>
</DD>
</DL>
<HR>

<A NAME="enableClientListener(boolean)"><!-- --></A><H3>
enableClientListener</H3>
<PRE>
void <B>enableClientListener</B>(boolean&nbsp;enabled)</PRE>
<DL>
<DD>Sets if the port listener for unsecured clients will be available or not. When disabled
 there won't be a port listener active. Therefore, new clients won't be able to connect to
 the server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if new unsecured clients will be able to connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="isClientListenerEnabled()"><!-- --></A><H3>
isClientListenerEnabled</H3>
<PRE>
boolean <B>isClientListenerEnabled</B>()</PRE>
<DL>
<DD>Returns true if the port listener for unsecured clients is available. When disabled
 there won't be a port listener active. Therefore, new clients won't be able to connect to
 the server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the port listener for unsecured clients is available.</DL>
</DD>
</DL>
<HR>

<A NAME="enableClientSSLListener(boolean)"><!-- --></A><H3>
enableClientSSLListener</H3>
<PRE>
void <B>enableClientSSLListener</B>(boolean&nbsp;enabled)</PRE>
<DL>
<DD>Sets if the port listener for secured clients will be available or not. When disabled
 there won't be a port listener active. Therefore, new secured clients won't be able to
 connect to the server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if new secured clients will be able to connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="isClientSSLListenerEnabled()"><!-- --></A><H3>
isClientSSLListenerEnabled</H3>
<PRE>
boolean <B>isClientSSLListenerEnabled</B>()</PRE>
<DL>
<DD>Returns true if the port listener for secured clients is available. When disabled
 there won't be a port listener active. Therefore, new secured clients won't be able to
 connect to the server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the port listener for unsecured clients is available.</DL>
</DD>
</DL>
<HR>

<A NAME="enableComponentListener(boolean)"><!-- --></A><H3>
enableComponentListener</H3>
<PRE>
void <B>enableComponentListener</B>(boolean&nbsp;enabled)</PRE>
<DL>
<DD>Sets if the port listener for external components will be available or not. When disabled
 there won't be a port listener active. Therefore, new external components won't be able to
 connect to the server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if new external components will be able to connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="isComponentListenerEnabled()"><!-- --></A><H3>
isComponentListenerEnabled</H3>
<PRE>
boolean <B>isComponentListenerEnabled</B>()</PRE>
<DL>