xmppserver.html

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

<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the JID to check.
<DT><B>Returns:</B><DD>true if the given address does not match the local server hostname and does not
         match a component service JID.</DL>
</DD>
</DL>
<HR>

<A NAME="getNodeID()"><!-- --></A><H3>
getNodeID</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/cluster/NodeID.html" title="class in org.jivesoftware.openfire.cluster">NodeID</A> <B>getNodeID</B>()</PRE>
<DL>
<DD>Returns an ID that uniquely identifies this server in a cluster. When not running in cluster mode
 the returned value is always the same. However, when in cluster mode the value should be set
 when joining the cluster and must be unique even upon restarts of this node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an ID that uniquely identifies this server in a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="setNodeID(org.jivesoftware.openfire.cluster.NodeID)"><!-- --></A><H3>
setNodeID</H3>
<PRE>
public void <B>setNodeID</B>(<A HREF="../../../org/jivesoftware/openfire/cluster/NodeID.html" title="class in org.jivesoftware.openfire.cluster">NodeID</A>&nbsp;nodeID)</PRE>
<DL>
<DD>Sets an ID that uniquely identifies this server in a cluster. When not running in cluster mode
 the returned value is always the same. However, when in cluster mode the value should be set
 when joining the cluster and must be unique even upon restarts of this node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeID</CODE> - an ID that uniquely identifies this server in a cluster or null if not in a cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="matchesComponent(org.xmpp.packet.JID)"><!-- --></A><H3>
matchesComponent</H3>
<PRE>
public boolean <B>matchesComponent</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD>Returns true if the given address matches a component service JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the JID to check.
<DT><B>Returns:</B><DD>true if the given address matches a component service JID.</DL>
</DD>
</DL>
<HR>

<A NAME="createJID(java.lang.String, java.lang.String)"><!-- --></A><H3>
createJID</H3>
<PRE>
public <A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>createJID</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;username,
                     <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;resource)</PRE>
<DL>
<DD>Creates an XMPPAddress local to this server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the user name portion of the id or null to indicate none is needed.<DD><CODE>resource</CODE> - the resource portion of the id or null to indicate none is needed.
<DT><B>Returns:</B><DD>an XMPPAddress for the server.</DL>
</DD>
</DL>
<HR>

<A NAME="createJID(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
createJID</H3>
<PRE>
public <A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>createJID</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;username,
                     <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;resource,
                     boolean&nbsp;skipStringprep)</PRE>
<DL>
<DD>Creates an XMPPAddress local to this server. The construction of the new JID
 can be optimized by skipping stringprep operations.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the user name portion of the id or null to indicate none is needed.<DD><CODE>resource</CODE> - the resource portion of the id or null to indicate none is needed.<DD><CODE>skipStringprep</CODE> - true if stringprep should not be applied.
<DT><B>Returns:</B><DD>an XMPPAddress for the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getAdmins()"><!-- --></A><H3>
getAdmins</H3>
<PRE>
public <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/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&gt; <B>getAdmins</B>()</PRE>
<DL>
<DD>Returns a collection with the JIDs of the server's admins. The collection may include
 JIDs of local users and users of remote servers.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a collection with the JIDs of the server's admins.</DL>
</DD>
</DL>
<HR>

<A NAME="addServerListener(org.jivesoftware.openfire.XMPPServerListener)"><!-- --></A><H3>
addServerListener</H3>
<PRE>
public void <B>addServerListener</B>(<A HREF="../../../org/jivesoftware/openfire/XMPPServerListener.html" title="interface in org.jivesoftware.openfire">XMPPServerListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Adds a new server listener that will be notified when the server has been started
 or is about to be stopped.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the new server listener to add.</DL>
</DD>
</DL>
<HR>

<A NAME="removeServerListener(org.jivesoftware.openfire.XMPPServerListener)"><!-- --></A><H3>
removeServerListener</H3>
<PRE>
public void <B>removeServerListener</B>(<A HREF="../../../org/jivesoftware/openfire/XMPPServerListener.html" title="interface in org.jivesoftware.openfire">XMPPServerListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Removes a server listener that was being notified when the server was being started
 or was about to be stopped.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the server listener to remove.</DL>
</DD>
</DL>
<HR>

<A NAME="finishSetup()"><!-- --></A><H3>
finishSetup</H3>
<PRE>
public void <B>finishSetup</B>()</PRE>
<DL>
<DD>Finish the setup process. Because this method is meant to be called from inside
 the Admin console plugin, it spawns its own thread to do the work so that the
 class loader is correct.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="restart()"><!-- --></A><H3>
restart</H3>
<PRE>
public void <B>restart</B>()</PRE>
<DL>
<DD>Restarts the server and all it's modules only if the server is restartable. Otherwise do
 nothing.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="restartHTTPServer()"><!-- --></A><H3>
restartHTTPServer</H3>
<PRE>
public void <B>restartHTTPServer</B>()</PRE>
<DL>
<DD>Restarts the HTTP server only when running in stand alone mode. The restart
 process will be done in another thread that will wait 1 second before doing
 the actual restart. The delay will give time to the page that requested the
 restart to fully render its content.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public void <B>stop</B>()</PRE>
<DL>
<DD>Stops the server only if running in standalone mode. Do nothing if the server is running
 inside of another server.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isSetupMode()"><!-- --></A><H3>
isSetupMode</H3>
<PRE>
public boolean <B>isSetupMode</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isRestartable()"><!-- --></A><H3>
isRestartable</H3>
<PRE>
public boolean <B>isRestartable</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isStandAlone()"><!-- --></A><H3>
isStandAlone</H3>
<PRE>
public boolean <B>isStandAlone</B>()</PRE>
<DL>
<DD>Returns if the server is running in standalone mode. We consider that it's running in
 standalone if the "org.jivesoftware.openfire.starter.ServerStarter" class is present in the
 system.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the server is running in standalone mode.</DL>
</DD>
</DL>
<HR>

<A NAME="isShuttingDown()"><!-- --></A><H3>
isShuttingDown</H3>
<PRE>
public boolean <B>isShuttingDown</B>()</PRE>
<DL>
<DD>Returns true if the server is being shutdown.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the server is being shutdown.</DL>
</DD>
</DL>
<HR>

<A NAME="getConnectionManager()"><!-- --></A><H3>
getConnectionManager</H3>
<PRE>
public <A HREF="../../../org/jivesoftware/openfire/ConnectionManager.html" title="interface in org.jivesoftware.openfire">ConnectionManager</A> <B>getConnectionManager</B>()</PRE>
<DL>
<DD>Returns the <code>ConnectionManager</code> registered with this server. The
 <code>ConnectionManager</code> was registered with the server as a module while starting up
 the server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the <code>ConnectionManager</code> registered with this server.</DL>