routingtableimpl.html

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

<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#isAnonymousRoute(org.xmpp.packet.JID)">isAnonymousRoute</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the full JID of the anonymous user.
<DT><B>Returns:</B><DD>true if an anonymous user with the specified full JID is currently logged.</DL>
</DD>
</DL>
<HR>

<A NAME="isLocalRoute(org.xmpp.packet.JID)"><!-- --></A><H3>
isLocalRoute</H3>
<PRE>
public boolean <B>isLocalRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#isLocalRoute(org.xmpp.packet.JID)">RoutingTable</A></CODE></B></DD>
<DD>Returns true if the specified address belongs to a route that is hosted by this JVM.
 When running inside of a cluster each cluster node will host routes to local resources.
 A false value could either mean that the route is not hosted by this JVM but other
 cluster node or that there is no route to the specified address. Use
 <A HREF="../../../../org/jivesoftware/openfire/XMPPServer.html#isLocal(org.xmpp.packet.JID)"><CODE>XMPPServer.isLocal(org.xmpp.packet.JID)</CODE></A> to figure out if the address
 belongs to tge domain hosted by this server.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#isLocalRoute(org.xmpp.packet.JID)">isLocalRoute</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the address of the route.
<DT><B>Returns:</B><DD>true if the specified address belongs to a route that is hosted by this JVM.</DL>
</DD>
</DL>
<HR>

<A NAME="hasServerRoute(org.xmpp.packet.JID)"><!-- --></A><H3>
hasServerRoute</H3>
<PRE>
public boolean <B>hasServerRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#hasServerRoute(org.xmpp.packet.JID)">RoutingTable</A></CODE></B></DD>
<DD>Returns true if an outgoing server session exists to the specified remote server.
 The JID can be a full JID or a bare JID since only the domain of the specified
 address will be used to look up the route.<p>

 When running inside of a cluster the look up will be done in all the cluster. So
 as long as a node has a connection to the remote server a true value will be
 returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#hasServerRoute(org.xmpp.packet.JID)">hasServerRoute</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - JID that specifies the remote server address.
<DT><B>Returns:</B><DD>true if an outgoing server session exists to the specified remote server.</DL>
</DD>
</DL>
<HR>

<A NAME="hasComponentRoute(org.xmpp.packet.JID)"><!-- --></A><H3>
hasComponentRoute</H3>
<PRE>
public boolean <B>hasComponentRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#hasComponentRoute(org.xmpp.packet.JID)">RoutingTable</A></CODE></B></DD>
<DD>Returns true if an internal or external component is hosting the specified address.
 The JID can be a full JID or a bare JID since only the domain of the specified
 address will be used to look up the route.<p>

 When running inside of a cluster the look up will be done in all the cluster. So
 as long as a node is hosting the component  a true value will be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#hasComponentRoute(org.xmpp.packet.JID)">hasComponentRoute</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - JID that specifies the component address.
<DT><B>Returns:</B><DD>true if an internal or external component is hosting the specified address.</DL>
</DD>
</DL>
<HR>

<A NAME="getRoutes(org.xmpp.packet.JID, org.xmpp.packet.JID)"><!-- --></A><H3>
getRoutes</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/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&gt; <B>getRoutes</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route,
                           <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;requester)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#getRoutes(org.xmpp.packet.JID, org.xmpp.packet.JID)">RoutingTable</A></CODE></B></DD>
<DD>Returns the list of routes associated to the specified route address. When asking
 for routes to a remote server then the requested JID will be included as the only
 value of the returned collection. It is indifferent if an outgoing session to the
 specified remote server exists or not.<p>

 When asking for routes to client sessions the specified route address could either
 be a full JID of a bare JID. In the case of a full JID, a single element will be
 included in the answer in case the specified full JID exists or an empty collection
 if the full JID does not exist. Moreover, when passing a bare JID a list of full
 JIDs will be returned for each available resource associated to the bare JID. In
 any case, only JIDs of <tt>available</tt> client sessions are returned. However,
 there is an exception with directed presences. Unavailable routes may be returned
 if and only if the owner of the route sent a directed presence to the requester
 thus becoming available to the requester. If requester is <tt>null</tt> then only
 available resources are considered.<p>

 When asking for routes to components a single element will be returned in the answer
 only if an internal or external component is found for the specified route address.
 If no component was found then an empty collection will be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#getRoutes(org.xmpp.packet.JID, org.xmpp.packet.JID)">getRoutes</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>route</CODE> - The address we want a route to.<DD><CODE>requester</CODE> - The address of the entity requesting the routes or null if we don't
 care about directed presences.
<DT><B>Returns:</B><DD>list of routes associated to the specified route address.</DL>
</DD>
</DL>
<HR>

<A NAME="removeClientRoute(org.xmpp.packet.JID)"><!-- --></A><H3>
removeClientRoute</H3>
<PRE>
public boolean <B>removeClientRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#removeClientRoute(org.xmpp.packet.JID)">RoutingTable</A></CODE></B></DD>
<DD>Returns true if a route of a client session has been successfully removed. When running
 inside of a cluster this message <tt>must</tt> be sent from the cluster node that is
 actually hosting the client session.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#removeClientRoute(org.xmpp.packet.JID)">removeClientRoute</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>route</CODE> - the route to remove.
<DT><B>Returns:</B><DD>true if a route of a client session has been successfully removed.</DL>
</DD>
</DL>
<HR>

<A NAME="removeServerRoute(org.xmpp.packet.JID)"><!-- --></A><H3>
removeServerRoute</H3>
<PRE>
public boolean <B>removeServerRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#removeServerRoute(org.xmpp.packet.JID)">RoutingTable</A></CODE></B></DD>
<DD>Returns true if a route to an outoing server has been successfully removed. When running
 inside of a cluster this message <tt>must</tt> be sent from the cluster node that is
 actually holding the physical connectoin to the remote server.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#removeServerRoute(org.xmpp.packet.JID)">removeServerRoute</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>route</CODE> - the route to remove.
<DT><B>Returns:</B><DD>true if the route was successfully removed.</DL>
</DD>
</DL>
<HR>

<A NAME="removeComponentRoute(org.xmpp.packet.JID)"><!-- --></A><H3>
removeComponentRoute</H3>
<PRE>
public boolean <B>removeComponentRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#removeComponentRoute(org.xmpp.packet.JID)">RoutingTable</A></CODE></B></DD>
<DD>Returns true if a route of a component has been successfully removed. Both internal
 and external components have a route in the table. When running inside of a cluster
 this message <tt>must</tt> be sent from the cluster node that is actually hosting the
 component.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#removeComponentRoute(org.xmpp.packet.JID)">removeComponentRoute</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>route</CODE> - the route to remove.
<DT><B>Returns:</B><DD>true if a route of a component has been successfully removed.</DL>
</DD>
</DL>
<HR>

<A NAME="setRemotePacketRouter(org.jivesoftware.openfire.RemotePacketRouter)"><!-- --></A><H3>
setRemotePacketRouter</H3>
<PRE>
public void <B>setRemotePacketRouter</B>(<A HREF="../../../../org/jivesoftware/openfire/RemotePacketRouter.html" title="interface in org.jivesoftware.openfire">RemotePacketRouter</A>&nbsp;remotePacketRouter)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#setRemotePacketRouter(org.jivesoftware.openfire.RemotePacketRouter)">RoutingTable</A></CODE></B></DD>
<DD>Sets the <A HREF="../../../../org/jivesoftware/openfire/RemotePacketRouter.html" title="interface in org.jivesoftware.openfire"><CODE>RemotePacketRouter</CODE></A> to use for deliverying packets to entities hosted
 in remote nodes of the cluster.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#setRemotePacketRouter(org.jivesoftware.openfire.RemotePacketRouter)">setRemotePacketRouter</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>remotePacketRouter</CODE> - the RemotePacketRouter to use for deliverying packets to entities hosted
        in remote nodes of the cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="getRemotePacketRouter()"><!-- --></A><H3>
getRemotePacketRouter</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/RemotePacketRout