routingtableimpl.html

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

            <A HREF="../../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A>&nbsp;packet,
            boolean&nbsp;fromServer)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Routes a packet to the specified address.</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/spi/RoutingTableImpl.html#setRemotePacketRouter(org.jivesoftware.openfire.RemotePacketRouter)">setRemotePacketRouter</A></B>(<A HREF="../../../../org/jivesoftware/openfire/RemotePacketRouter.html" title="interface in org.jivesoftware.openfire">RemotePacketRouter</A>&nbsp;remotePacketRouter)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</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/spi/RoutingTableImpl.html#start()">start</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts the basic module.</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/spi/RoutingTableImpl.html#stop()">stop</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stops the basic module.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.jivesoftware.openfire.container.BasicModule"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.jivesoftware.openfire.container.<A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#destroy()">destroy</A>, <A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#getName()">getName</A></CODE></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="C2S_CACHE_NAME"><!-- --></A><H3>
C2S_CACHE_NAME</H3>
<PRE>
public static final <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>C2S_CACHE_NAME</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.spi.RoutingTableImpl.C2S_CACHE_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ANONYMOUS_C2S_CACHE_NAME"><!-- --></A><H3>
ANONYMOUS_C2S_CACHE_NAME</H3>
<PRE>
public static final <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>ANONYMOUS_C2S_CACHE_NAME</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.spi.RoutingTableImpl.ANONYMOUS_C2S_CACHE_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="S2S_CACHE_NAME"><!-- --></A><H3>
S2S_CACHE_NAME</H3>
<PRE>
public static final <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>S2S_CACHE_NAME</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.spi.RoutingTableImpl.S2S_CACHE_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="COMPONENT_CACHE_NAME"><!-- --></A><H3>
COMPONENT_CACHE_NAME</H3>
<PRE>
public static final <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>COMPONENT_CACHE_NAME</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.spi.RoutingTableImpl.COMPONENT_CACHE_NAME">Constant Field Values</A></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="RoutingTableImpl()"><!-- --></A><H3>
RoutingTableImpl</H3>
<PRE>
public <B>RoutingTableImpl</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="addServerRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.session.LocalOutgoingServerSession)"><!-- --></A><H3>
addServerRoute</H3>
<PRE>
public void <B>addServerRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route,
                           <A HREF="../../../../org/jivesoftware/openfire/session/LocalOutgoingServerSession.html" title="class in org.jivesoftware.openfire.session">LocalOutgoingServerSession</A>&nbsp;destination)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#addServerRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.session.LocalOutgoingServerSession)">RoutingTable</A></CODE></B></DD>
<DD>Adds a route to the routing table for the specified outoing server session. 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#addServerRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.session.LocalOutgoingServerSession)">addServerRoute</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 associated to the route.<DD><CODE>destination</CODE> - the outgoing server session.</DL>
</DD>
</DL>
<HR>

<A NAME="addComponentRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.RoutableChannelHandler)"><!-- --></A><H3>
addComponentRoute</H3>
<PRE>
public void <B>addComponentRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route,
                              <A HREF="../../../../org/jivesoftware/openfire/RoutableChannelHandler.html" title="interface in org.jivesoftware.openfire">RoutableChannelHandler</A>&nbsp;destination)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#addComponentRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.RoutableChannelHandler)">RoutingTable</A></CODE></B></DD>
<DD>Adds a route to the routing table for the specified internal or external component. <p>

 When running inside of a cluster this message <tt>must</tt> be sent from the cluster
 node that is actually hosting the component. The component may be available in all
 or some of cluster nodes. The routing table will keep track of all nodes hosting
 the component.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#addComponentRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.RoutableChannelHandler)">addComponentRoute</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 associated to the route.<DD><CODE>destination</CODE> - the component.</DL>
</DD>
</DL>
<HR>

<A NAME="addClientRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.session.LocalClientSession)"><!-- --></A><H3>
addClientRoute</H3>
<PRE>
public boolean <B>addClientRoute</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;route,
                              <A HREF="../../../../org/jivesoftware/openfire/session/LocalClientSession.html" title="class in org.jivesoftware.openfire.session">LocalClientSession</A>&nbsp;destination)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#addClientRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.session.LocalClientSession)">RoutingTable</A></CODE></B></DD>
<DD>Adds a route to the routing table for the specified client session. The client
 session will be added as soon as the user has finished authenticating with the server.
 Moreover, when the user becomes available or unavailable then the routing table will
 get updated again. When running inside of a cluster this message <tt>must</tt> be sent
 from the cluster node that is actually holding the client session.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#addClientRoute(org.xmpp.packet.JID, org.jivesoftware.openfire.session.LocalClientSession)">addClientRoute</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 associated to the route.<DD><CODE>destination</CODE> - the client session.
<DT><B>Returns:</B><DD>true if route was added to the table or false if already present.</DL>
</DD>
</DL>
<HR>

<A NAME="broadcastPacket(org.xmpp.packet.Message, boolean)"><!-- --></A><H3>
broadcastPacket</H3>
<PRE>
public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#broadcastPacket(org.xmpp.packet.Message, boolean)">RoutingTable</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html#broadcastPacket(org.xmpp.packet.Message, boolean)">broadcastPacket</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/RoutingTable.html" title="interface in org.jivesoftware.openfire">RoutingTable</A></CODE></DL>