pepservice.html

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

</DL>
<HR>

<A NAME="sendNotification(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.Message, org.xmpp.packet.JID)"><!-- --></A><H3>
sendNotification</H3>
<PRE>
public void <B>sendNotification</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A>&nbsp;node,
                             <A HREF="../../../../org/xmpp/packet/Message.html" title="class in org.xmpp.packet">Message</A>&nbsp;message,
                             <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;recipientJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#sendNotification(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.Message, org.xmpp.packet.JID)">PubSubService</A></CODE></B></DD>
<DD>Sends the specified Message containing an event notification to a specific
 subscriber of the specified node. The message being sent has to have a unique
 ID value so that the service can properly track any notification-related errors
 that may occur.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#sendNotification(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.Message, org.xmpp.packet.JID)">sendNotification</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node that triggered the event notification.<DD><CODE>message</CODE> - the message containing the event notification.<DD><CODE>recipientJID</CODE> - the entity to get the event notification.</DL>
</DD>
</DL>
<HR>

<A NAME="sendLastPublishedItems(org.xmpp.packet.JID)"><!-- --></A><H3>
sendLastPublishedItems</H3>
<PRE>
public void <B>sendLastPublishedItems</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;recipientJID)</PRE>
<DL>
<DD>Sends an event notification for the last published item of each leaf node under the
 root collection node to the recipient JID. If the recipient has no subscription to
 the root collection node, has not yet been authorized, or is pending to be
 configured -- then no notifications are going to be sent.<p>

 Depending on the subscription configuration the event notifications may or may not have
 a payload, may not be sent if a keyword (i.e. filter) was defined and it was not matched.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>recipientJID</CODE> - the recipient that is to receive the last published item notifications.</DL>
</DD>
</DL>
<HR>

<A NAME="queueItemToAdd(org.jivesoftware.openfire.pubsub.PublishedItem)"><!-- --></A><H3>
queueItemToAdd</H3>
<PRE>
public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#queueItemToAdd(org.jivesoftware.openfire.pubsub.PublishedItem)">PubSubService</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#queueItemToAdd(org.jivesoftware.openfire.pubsub.PublishedItem)">queueItemToAdd</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newItem</CODE> - the item to add to the database.</DL>
</DD>
</DL>
<HR>

<A NAME="queueItemToRemove(org.jivesoftware.openfire.pubsub.PublishedItem)"><!-- --></A><H3>
queueItemToRemove</H3>
<PRE>
public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#queueItemToRemove(org.jivesoftware.openfire.pubsub.PublishedItem)">PubSubService</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#queueItemToRemove(org.jivesoftware.openfire.pubsub.PublishedItem)">queueItemToRemove</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>removedItem</CODE> - the item to remove from the database.</DL>
</DD>
</DL>
<HR>

<A NAME="getBarePresences()"><!-- --></A><H3>
getBarePresences</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</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>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</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>,<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;&gt; <B>getBarePresences</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getBarePresences()">PubSubService</A></CODE></B></DD>
<DD>Returns a registry of the presence's show value of users that subscribed to a node of
 the pubsub service and for which the node only delivers notifications for online users
 or node subscriptions deliver events based on the user presence show value. Offline
 users will not have an entry in the map. Note: Key-> bare JID and Value-> Map whose key
 is full JID of connected resource and value is show value of the last received presence.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getBarePresences()">getBarePresences</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a registry of the presence's show value of users that subscribed to a node
         of the pubsub service.</DL>
</DD>
</DL>
<HR>

<A NAME="getItemsToAdd()"><!-- --></A><H3>
getItemsToAdd</H3>
<PRE>
public <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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getItemsToAdd()">PubSubService</A></CODE></B></DD>
<DD>Gets the queue that holds the items that need to be added to the database.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getItemsToAdd()">getItemsToAdd</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<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>
public <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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getItemsToDelete()">PubSubService</A></CODE></B></DD>
<DD>Gets the queue that holds the items that need to be deleted from the database.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getItemsToDelete()">getItemsToDelete</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<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>
public <A HREF="../../../../org/jivesoftware/openfire/commands/AdHocCommandManager.html" title="class in org.jivesoftware.openfire.commands">AdHocCommandManager</A> <B>getManager</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getManager()">PubSubService</A></CODE></B></DD>
<DD>Returns the ad-hoc commands manager used for this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getManager()">getManager</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<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>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItemTask.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItemTask</A> <B>getPublishedItemTask</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getPublishedItemTask()">PubSubService</A></CODE></B></DD>
<DD>Returns the published item task used for this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getPublishedItemTask()">getPublishedItemTask</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<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>
public 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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#setPublishedItemTask(org.jivesoftware.openfire.pubsub.PublishedItemTask)">PubSubService</A></CODE></B></DD>
<DD>Sets the published item task used for this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#setPublishedItemTask(org.jivesoftware.openfire.pubsub.PublishedItemTask)">setPublishedItemTask</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html" title="interface in org.jivesoftware.openfire.pubsub">PubSubService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>task</CODE> - the PublishedItemTask to set for this service.</DL>
</DD>
</DL>
<HR>

<A NAME="getTimer()"><!-- --></A><H3>
getTimer</H3>
<PRE>
public <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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getTimer()">PubSubService</A></CODE></B></DD>
<DD>Returns the timer used for the maintenance process of this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD>