pubsubmodule.html

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

<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#canCreateNode(org.xmpp.packet.JID)">canCreateNode</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>creator</CODE> - the JID of the entity trying to create a new node.
<DT><B>Returns:</B><DD>true if the pubsub service allows the specified user to create nodes.</DL>
</DD>
</DL>
<HR>

<A NAME="isServiceAdmin(org.xmpp.packet.JID)"><!-- --></A><H3>
isServiceAdmin</H3>
<PRE>
public boolean <B>isServiceAdmin</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isServiceAdmin(org.xmpp.packet.JID)">PubSubService</A></CODE></B></DD>
<DD>Returns true if the specified user is a sysadmin of the pubsub service or has
 admin privileges.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isServiceAdmin(org.xmpp.packet.JID)">isServiceAdmin</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>user</CODE> - the user to check if he has admin privileges.
<DT><B>Returns:</B><DD>true if the specified user is a sysadmin of the pubsub service or has
         admin privileges.</DL>
</DD>
</DL>
<HR>

<A NAME="isInstantNodeSupported()"><!-- --></A><H3>
isInstantNodeSupported</H3>
<PRE>
public boolean <B>isInstantNodeSupported</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isInstantNodeSupported()">PubSubService</A></CODE></B></DD>
<DD>Returns true if the pubsub service allows users to create nodes without specifying
 the node ID. The service will create a random node ID and assigne it to the node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isInstantNodeSupported()">isInstantNodeSupported</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>true if the pubsub service allows users to create nodes without specifying
         the node ID.</DL>
</DD>
</DL>
<HR>

<A NAME="isCollectionNodesSupported()"><!-- --></A><H3>
isCollectionNodesSupported</H3>
<PRE>
public boolean <B>isCollectionNodesSupported</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isCollectionNodesSupported()">PubSubService</A></CODE></B></DD>
<DD>Returns true if the pubsub service supports collection nodes. When collection nodes is
 supported it is possible to create hierarchy of nodes where a <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>CollectionNode</CODE></A>
 may only hold children nodes of type <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>CollectionNode</CODE></A> or <A HREF="../../../../org/jivesoftware/openfire/pubsub/LeafNode.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>LeafNode</CODE></A>. On the
 other hand, <A HREF="../../../../org/jivesoftware/openfire/pubsub/LeafNode.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>LeafNode</CODE></A> can only hold <A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>PublishedItem</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isCollectionNodesSupported()">isCollectionNodesSupported</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>true if the pubsub service supports collection nodes.</DL>
</DD>
</DL>
<HR>

<A NAME="getRootCollectionNode()"><!-- --></A><H3>
getRootCollectionNode</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub">CollectionNode</A> <B>getRootCollectionNode</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getRootCollectionNode()">PubSubService</A></CODE></B></DD>
<DD>Returns the <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>CollectionNode</CODE></A> that acts as the root node of the entire
 node hierarchy. The returned node does not have a node identifier. If collection
 nodes is not supported then return <tt>null</tt>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getRootCollectionNode()">getRootCollectionNode</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 CollectionNode that acts as the root node of the entire node hierarchy
         or <tt>null</tt> if collection nodes is not supported.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultNodeConfiguration(boolean)"><!-- --></A><H3>
getDefaultNodeConfiguration</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html" title="class in org.jivesoftware.openfire.pubsub">DefaultNodeConfiguration</A> <B>getDefaultNodeConfiguration</B>(boolean&nbsp;leafType)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getDefaultNodeConfiguration(boolean)">PubSubService</A></CODE></B></DD>
<DD>Returns the default node configuration for the specified node type or <tt>null</tt>
 if the specified node type is not supported by the service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getDefaultNodeConfiguration(boolean)">getDefaultNodeConfiguration</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>leafType</CODE> - true when requesting default configuration of leaf nodes
<DT><B>Returns:</B><DD>the default node configuration for the specified node type or <tt>null</tt>
         if the specified node type is not supported by the service.</DL>
</DD>
</DL>
<HR>

<A NAME="getShowPresences(org.xmpp.packet.JID)"><!-- --></A><H3>
getShowPresences</H3>
<PRE>
public <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/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;subscriber)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getShowPresences(org.xmpp.packet.JID)">PubSubService</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getShowPresences(org.xmpp.packet.JID)">getShowPresences</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>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.Node, org.xmpp.packet.JID)"><!-- --></A><H3>
presenceSubscriptionNotRequired</H3>
<PRE>
public void <B>presenceSubscriptionNotRequired</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/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#presenceSubscriptionNotRequired(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)">PubSubService</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#presenceSubscriptionNotRequired(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)">presenceSubscriptionNotRequired</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 originated the unsubscription request.<DD><CODE>user</CODE> - the JID of the affiliate to unsubscribe from his presence.</DL>
</DD>
</DL>
<HR>

<A NAME="presenceSubscriptionRequired(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)"><!-- --></A><H3>
presenceSubscriptionRequired</H3>
<PRE>
public void <B>presenceSubscriptionRequired</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/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#presenceSubscriptionRequired(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)">PubSubService</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#presenceSubscriptionRequired(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)">presenceSubscriptionRequired</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 originated the subscription request.<DD><CODE>user</CODE> - the JID of the affiliate to subscribe to his presence.</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><