pubsubservice.html

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

                                     <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>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="isMultipleSubscriptionsEnabled()"><!-- --></A><H3>
isMultipleSubscriptionsEnabled</H3>
<PRE>
boolean <B>isMultipleSubscriptionsEnabled</B>()</PRE>
<DL>
<DD>Returns true if a user may have more than one subscription with the node. When
 multiple subscriptions is enabled each subscription request, event notification and
 unsubscription request should include a <tt>subid</tt> attribute.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if a user may have more than one subscription with the node.</DL>
</DD>
</DL>
<HR>

<A NAME="queueItemToAdd(org.jivesoftware.openfire.pubsub.PublishedItem)"><!-- --></A><H3>
queueItemToAdd</H3>
<PRE>
void <B>queueItemToAdd</B>(<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>newItem</CODE> - the item to add to the database.</DL>
</DD>
</DL>
<HR>

<A NAME="getItemsToAdd()"><!-- --></A><H3>
getItemsToAdd</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Queue.html" title="class or interface in java.util">Queue</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A>&gt; <B>getItemsToAdd</B>()</PRE>
<DL>
<DD>Gets the queue that holds the items that need to be added to the database.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the queue that holds the items that need to be added to the database.</DL>
</DD>
</DL>
<HR>

<A NAME="getItemsToDelete()"><!-- --></A><H3>
getItemsToDelete</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Queue.html" title="class or interface in java.util">Queue</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A>&gt; <B>getItemsToDelete</B>()</PRE>
<DL>
<DD>Gets the queue that holds the items that need to be deleted from the database.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the queue that holds the items that need to be deleted from the database.</DL>
</DD>
</DL>
<HR>

<A NAME="getManager()"><!-- --></A><H3>
getManager</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/commands/AdHocCommandManager.html" title="class in org.jivesoftware.openfire.commands">AdHocCommandManager</A> <B>getManager</B>()</PRE>
<DL>
<DD>Returns the ad-hoc commands manager used for this service.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the ad-hoc commands manager used for this service.</DL>
</DD>
</DL>
<HR>

<A NAME="getPublishedItemTask()"><!-- --></A><H3>
getPublishedItemTask</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItemTask.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItemTask</A> <B>getPublishedItemTask</B>()</PRE>
<DL>
<DD>Returns the published item task used for this service.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the published item task used for this service.</DL>
</DD>
</DL>
<HR>

<A NAME="setPublishedItemTask(org.jivesoftware.openfire.pubsub.PublishedItemTask)"><!-- --></A><H3>
setPublishedItemTask</H3>
<PRE>
void <B>setPublishedItemTask</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItemTask.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItemTask</A>&nbsp;task)</PRE>
<DL>
<DD>Sets the published item task used for this service.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>task</CODE> - the PublishedItemTask to set for this service.</DL>
</DD>
</DL>
<HR>

<A NAME="queueItemToRemove(org.jivesoftware.openfire.pubsub.PublishedItem)"><!-- --></A><H3>
queueItemToRemove</H3>
<PRE>
void <B>queueItemToRemove</B>(<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>removedItem</CODE> - the item to remove from the database.</DL>
</DD>
</DL>
<HR>

<A NAME="getTimer()"><!-- --></A><H3>
getTimer</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Timer.html" title="class or interface in java.util">Timer</A> <B>getTimer</B>()</PRE>
<DL>
<DD>Returns the timer used for the maintenance process of this service.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the timer used for the maintenance process of this service.</DL>
</DD>
</DL>
<HR>

<A NAME="getItemsTaskTimeout()"><!-- --></A><H3>
getItemsTaskTimeout</H3>
<PRE>
int <B>getItemsTaskTimeout</B>()</PRE>
<DL>
<DD>Returns the timeout value for the published items maintenance task.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the timeout value for the published items maintenance task.</DL>
</DD>
</DL>
<HR>

<A NAME="setItemsTaskTimeout(int)"><!-- --></A><H3>
setItemsTaskTimeout</H3>
<PRE>
void <B>setItemsTaskTimeout</B>(int&nbsp;timeout)</PRE>
<DL>
<DD>Sets the timeout value for the published items maintenance task.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the timeout value for the published items maintenance task.</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/PubSubPersistenceManager.html" title="class in org.jivesoftware.openfire.pubsub"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/pubsub/PubSubService.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PubSubService.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>