routingtable.html

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

<DT><B>Returns:</B><DD>the number of outgoing server sessions hosted in this JVM.</DL>
</DD>
</DL>
<HR>

<A NAME="getComponentsDomains()"><!-- --></A><H3>
getComponentsDomains</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="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&gt; <B>getComponentsDomains</B>()</PRE>
<DL>
<DD>Returns domains of components hosted by the server. When running in a cluster, domains of
 components running in any node will be returned.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>domains of components hosted by the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getRoutes(org.xmpp.packet.JID, org.xmpp.packet.JID)"><!-- --></A><H3>
getRoutes</H3>
<PRE>
<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>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>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>
boolean <B>removeClientRoute</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route)</PRE>
<DL>
<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>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>
boolean <B>removeServerRoute</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route)</PRE>
<DL>
<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>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>
boolean <B>removeComponentRoute</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route)</PRE>
<DL>
<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>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>
void <B>setRemotePacketRouter</B>(<A HREF="../../../org/jivesoftware/openfire/RemotePacketRouter.html" title="interface in org.jivesoftware.openfire">RemotePacketRouter</A>&nbsp;remotePacketRouter)</PRE>
<DL>
<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>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>
<A HREF="../../../org/jivesoftware/openfire/RemotePacketRouter.html" title="interface in org.jivesoftware.openfire">RemotePacketRouter</A> <B>getRemotePacketRouter</B>()</PRE>
<DL>
<DD>Returns 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 or <tt>null</tt> if none was set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the RemotePacketRouter to use for deliverying packets to entities hosted
        in remote nodes of the cluster.</DL>
</DD>
</DL>
<HR>

<A NAME="broadcastPacket(org.xmpp.packet.Message, boolean)"><!-- --></A><H3>
broadcastPacket</H3>
<PRE>
void <B>broadcastPacket</B>(<A HREF="../../../org/xmpp/packet/Message.html" title="class in org.xmpp.packet">Message</A>&nbsp;packet,
                     boolean&nbsp;onlyLocal)</PRE>
<DL>
<DD>Broadcasts the specified message to connected client sessions to the local node or
 across the cluster. Both available and unavailable client sessions will receive the message.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packet</CODE> - the message to broadcast.<DD><CODE>onlyLocal</CODE> - true if only client sessions connecte to the local JVM will get the message.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/jivesoftware/openfire/RoutableChannelHandler.html" title="interface in org.jivesoftware.openfire"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/jivesoftware/openfire/ServerPort.html" title="class in org.jivesoftware.openfire"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/jivesoftware/openfire/RoutingTable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RoutingTable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>