leafnode.html

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

protected <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="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A>&gt; <B>itemsByID</B></PRE>
<DL>
<DL>
</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="LeafNode(org.jivesoftware.openfire.pubsub.PubSubService, org.jivesoftware.openfire.pubsub.CollectionNode, java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
LeafNode</H3>
<PRE>
public <B>LeafNode</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/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub">CollectionNode</A>&nbsp;parentNode,
                <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>&nbsp;nodeID,
                <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;creator)</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="addFormFields(org.xmpp.forms.DataForm, boolean)"><!-- --></A><H3>
addFormFields</H3>
<PRE>
protected void <B>addFormFields</B>(<A HREF="../../../../org/xmpp/forms/DataForm.html" title="class in org.xmpp.forms">DataForm</A>&nbsp;form,
                             boolean&nbsp;isEditing)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#addFormFields(org.xmpp.forms.DataForm, boolean)">Node</A></CODE></B></DD>
<DD>Adds the required form fields to the specified form. When editing is true the field type
 and a label is included in each fields. The form being completed will contain the current
 node configuration. This information can be used for editing the node or for notifing that
 the node configuration has changed.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#addFormFields(org.xmpp.forms.DataForm, boolean)">addFormFields</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>form</CODE> - the form containing the node configuration.<DD><CODE>isEditing</CODE> - true when the form will be used to edit the node configuration.</DL>
</DD>
</DL>
<HR>

<A NAME="deletingNode()"><!-- --></A><H3>
deletingNode</H3>
<PRE>
protected void <B>deletingNode</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#deletingNode()">Node</A></CODE></B></DD>
<DD>Notification message indicating that the node is being deleted. Subclasses should
 implement this method to delete any subclass specific information.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#deletingNode()">deletingNode</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxPayloadSize()"><!-- --></A><H3>
getMaxPayloadSize</H3>
<PRE>
public int <B>getMaxPayloadSize</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isPersistPublishedItems()"><!-- --></A><H3>
isPersistPublishedItems</H3>
<PRE>
public boolean <B>isPersistPublishedItems</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxPublishedItems()"><!-- --></A><H3>
getMaxPublishedItems</H3>
<PRE>
public int <B>getMaxPublishedItems</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isItemRequired()"><!-- --></A><H3>
isItemRequired</H3>
<PRE>
public boolean <B>isItemRequired</B>()</PRE>
<DL>
<DD>Returns true if an item element is required to be included when publishing an
 item to this node. When an item is included then the item will have an item ID
 that will be included when sending items to node subscribers.<p>

 Leaf nodes that are transient and do not deliver payloads with event notifications
 do not require an item element. If a user tries to publish an item to a node
 that does not require items then an error will be returned.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if an item element is required to be included when publishing an
         item to this node.</DL>
</DD>
</DL>
<HR>

<A NAME="publishItems(org.xmpp.packet.JID, java.util.List)"><!-- --></A><H3>
publishItems</H3>
<PRE>
public void <B>publishItems</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;publisher,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;org.dom4j.Element&gt;&nbsp;itemElements)</PRE>
<DL>
<DD>Publishes the list of items to the node. Event notifications will be sent to subscribers
 for the new published event. The published event may or may not include an item. When the
 node is not persistent and does not require payloads then an item is not going to be created
 nore included in the event notification.<p>

 When an affiliate has many subscriptions to the node, the affiliate will get a
 notification for each set of items that affected the same list of subscriptions.<p>

 When an item is included in the published event then a new <A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>PublishedItem</CODE></A> is
 going to be created and added to the list of published item. Each published item will
 have a unique ID in the node scope. The new published item will be added to the end
 of the published list to keep the cronological order. When the max number of published
 items is exceeded then the oldest published items will be removed.<p>

 For performance reasons the newly added published items and the deleted items (if any)
 are saved to the database using a background thread. Sending event notifications to
 node subscribers may also use another thread to ensure good performance.<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>publisher</CODE> - the full JID of the user that sent the new published event.<DD><CODE>itemElements</CODE> - list of dom4j elements that contain info about the published items.</DL>
</DD>
</DL>
<HR>

<A NAME="deleteItems(java.util.List)"><!-- --></A><H3>
deleteItems</H3>
<PRE>
public void <B>deleteItems</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A>&gt;&nbsp;toDelete)</PRE>
<DL>
<DD>Deletes the list of published items from the node. Event notifications may be sent to
 subscribers for the deleted items. When an affiliate has many subscriptions to the node,
 the affiliate will get a notification for each set of items that affected the same list
 of subscriptions.<p>

 For performance reasons the deleted published items are saved to the database
 using a background thread. Sending event notifications to node subscribers may
 also use another thread to ensure good performance.<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>toDelete</CODE> - list of items that were deleted from the node.</DL>
</DD>
</DL>
<HR>

<A NAME="getPublishedItem(java.lang.String)"><!-- --></A><H3>