pubsubengine.html

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

<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="PubSubEngine(org.jivesoftware.openfire.PacketRouter)"><!-- --></A><H3>
PubSubEngine</H3>
<PRE>
public <B>PubSubEngine</B>(<A HREF="../../../../org/jivesoftware/openfire/PacketRouter.html" title="interface in org.jivesoftware.openfire">PacketRouter</A>&nbsp;router)</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="process(org.jivesoftware.openfire.pubsub.PubSubService, org.xmpp.packet.IQ)"><!-- --></A><H3>
process</H3>
<PRE>
public boolean <B>process</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                       <A HREF="../../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A>&nbsp;iq)</PRE>
<DL>
<DD>Handles IQ packets sent to the pubsub service. Requests of disco#info and disco#items
 are not being handled by the engine. Instead the service itself should handle disco packets.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>iq</CODE> - the IQ packet sent to the pubsub service.
<DT><B>Returns:</B><DD>true if the IQ packet was handled by the engine.</DL>
</DD>
</DL>
<HR>

<A NAME="process(org.jivesoftware.openfire.pubsub.PubSubService, org.xmpp.packet.Presence)"><!-- --></A><H3>
process</H3>
<PRE>
public void <B>process</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                    <A HREF="../../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A>&nbsp;presence)</PRE>
<DL>
<DD>Handles Presence packets sent to the pubsub service. Only process available and not
 available presences.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>presence</CODE> - the Presence packet sent to the pubsub service.</DL>
</DD>
</DL>
<HR>

<A NAME="process(org.jivesoftware.openfire.pubsub.PubSubService, org.xmpp.packet.Message)"><!-- --></A><H3>
process</H3>
<PRE>
public void <B>process</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                    <A HREF="../../../../org/xmpp/packet/Message.html" title="class in org.xmpp.packet">Message</A>&nbsp;message)</PRE>
<DL>
<DD>Handles Message packets sent to the pubsub service. Messages may be of type error
 when an event notification was sent to a susbcriber whose address is no longer available.<p>

 Answers to authorization requests sent to node owners to approve pending subscriptions
 will also be processed by this method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>message</CODE> - the Message packet sent to the pubsub service.</DL>
</DD>
</DL>
<HR>

<A NAME="start(org.jivesoftware.openfire.pubsub.PubSubService)"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="shutdown(org.jivesoftware.openfire.pubsub.PubSubService)"><!-- --></A><H3>
shutdown</H3>
<PRE>
public void <B>shutdown</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getShowPresences(org.jivesoftware.openfire.pubsub.PubSubService, org.xmpp.packet.JID)"><!-- --></A><H3>
getShowPresences</H3>
<PRE>
public static <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>getShowPresences</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                                                  <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;subscriber)</PRE>
<DL>
<DD>Returns the show values of the last know presence of all connected resources of the
 specified subscriber. When the subscriber JID is a bare JID then the answered collection
 will have many entries one for each connected resource. Moreover, if the user
 is offline then an empty collectin is returned. Available show status is represented
 by a <tt>online</tt> value. The rest of the possible show values as defined in RFC 3921.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>subscriber</CODE> - the JID of the subscriber. This is not the JID of the affiliate.
<DT><B>Returns:</B><DD>an empty collection when offline. Otherwise, a collection with the show value
         of each connected resource.</DL>
</DD>
</DL>
<HR>

<A NAME="presenceSubscriptionNotRequired(org.jivesoftware.openfire.pubsub.PubSubService, org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)"><!-- --></A><H3>
presenceSubscriptionNotRequired</H3>
<PRE>
public static void <B>presenceSubscriptionNotRequired</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                                                   <A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A>&nbsp;node,
                                                   <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD>Requests the pubsub service to subscribe to the presence of the user. If the service
 has already subscribed to the user's presence then do nothing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>node</CODE> - the node that originated the subscription request.<DD><CODE>user</CODE> - the JID of the affiliate to subscribe to his presence.</DL>
</DD>
</DL>
<HR>

<A NAME="presenceSubscriptionRequired(org.jivesoftware.openfire.pubsub.PubSubService, org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)"><!-- --></A><H3>
presenceSubscriptionRequired</H3>
<PRE>
public static void <B>presenceSubscriptionRequired</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                                                <A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A>&nbsp;node,
                                                <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD>Requests the pubsub service to unsubscribe from the presence of the user. If the service
 was not subscribed to the user's presence or any node still requires to be subscribed to
 the user presence then do nothing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>node</CODE> - the node that originated the unsubscription request.<DD><CODE>user</CODE> - the JID of the affiliate to unsubscribe from his presence.</DL>
</DD>
</DL>
<HR>

<A NAME="queueItemToRemove(org.jivesoftware.openfire.pubsub.PubSubService, org.jivesoftware.openfire.pubsub.PublishedItem)"><!-- --></A><H3>
queueItemToRemove</H3>
<PRE>
public static void <B>queueItemToRemove</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                                     <A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A>&nbsp;removedItem)</PRE>
<DL>
<DD>Adds the item to the queue of items to remove from the database. The queue is going
 to be processed by another thread.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>removedItem</CODE> - the item to remove from the database.</DL>
</DD>
</DL>
<HR>

<A NAME="queueItemToAdd(org.jivesoftware.openfire.pubsub.PubSubService, org.jivesoftware.openfire.pubsub.PublishedItem)"><!-- --></A><H3>
queueItemToAdd</H3>
<PRE>
public static void <B>queueItemToAdd</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A>&nbsp;service,
                                  <A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A>&nbsp;newItem)</PRE>
<DL>
<DD>Adds the item to the queue of items to add to the database. The queue is going
 to be processed by another thread.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - the PubSub service this action is to be performed for.<DD><CODE>newItem</CODE> - the item to add to the database.</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/pubsub/PublishedItemTask.html" title="class in org.jivesoftware.openfire.pubsub"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubModule.html" title="class in org.jivesoftware.openfire.pubsub"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/pubsub/PubSubEngine.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PubSubEngine.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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>