defaultnodeconfiguration.html

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

<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setMaxPublishedItems(int)">setMaxPublishedItems</A></B>(int&nbsp;maxPublishedItems)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the maximum number of published items to persist.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setNotifyConfigChanges(boolean)">setNotifyConfigChanges</A></B>(boolean&nbsp;notifyConfigChanges)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if subscribers are going to be notified when node configuration changes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setNotifyDelete(boolean)">setNotifyDelete</A></B>(boolean&nbsp;notifyDelete)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if subscribers are going to be notified when node is deleted.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setNotifyRetract(boolean)">setNotifyRetract</A></B>(boolean&nbsp;notifyRetract)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if subscribers are going to be notified when items are removed from the node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setPersistPublishedItems(boolean)">setPersistPublishedItems</A></B>(boolean&nbsp;persistPublishedItems)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if items are going to be persisted in a storage.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setPresenceBasedDelivery(boolean)">setPresenceBasedDelivery</A></B>(boolean&nbsp;presenceBasedDelivery)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if notifications are going to be delivered only to available users.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setPublisherModel(org.jivesoftware.openfire.pubsub.models.PublisherModel)">setPublisherModel</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/models/PublisherModel.html" title="class in org.jivesoftware.openfire.pubsub.models">PublisherModel</A>&nbsp;publisherModel)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the publisher model that specifies who is allowed to publish items to the node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setReplyPolicy(org.jivesoftware.openfire.pubsub.Node.ItemReplyPolicy)">setReplyPolicy</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.ItemReplyPolicy.html" title="enum in org.jivesoftware.openfire.pubsub">Node.ItemReplyPolicy</A>&nbsp;replyPolicy)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the policy that defines whether owners or publisher should receive replies to items.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setSendItemSubscribe(boolean)">setSendItemSubscribe</A></B>(boolean&nbsp;sendItemSubscribe)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if new subscribers are going to receive new items once subscribed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/DefaultNodeConfiguration.html#setSubscriptionEnabled(boolean)">setSubscriptionEnabled</A></B>(boolean&nbsp;subscriptionEnabled)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if subscribing and unsubscribing are enabled.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= 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="DefaultNodeConfiguration(boolean)"><!-- --></A><H3>
DefaultNodeConfiguration</H3>
<PRE>
public <B>DefaultNodeConfiguration</B>(boolean&nbsp;isLeafType)</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="isLeaf()"><!-- --></A><H3>
isLeaf</H3>
<PRE>
public boolean <B>isLeaf</B>()</PRE>
<DL>
<DD>Returns true if this default configutation belongs to a leaf node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if this default configutation belongs to a leaf node.</DL>
</DD>
</DL>
<HR>

<A NAME="isDeliverPayloads()"><!-- --></A><H3>
isDeliverPayloads</H3>
<PRE>
public boolean <B>isDeliverPayloads</B>()</PRE>
<DL>
<DD>Returns true if payloads are going to be delivered with event notifications.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if payloads are going to be delivered with event notifications.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxPayloadSize()"><!-- --></A><H3>
getMaxPayloadSize</H3>
<PRE>
public int <B>getMaxPayloadSize</B>()</PRE>
<DL>
<DD>Returns the maximum payload size in bytes.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the maximum payload size in bytes.</DL>
</DD>
</DL>
<HR>

<A NAME="isPersistPublishedItems()"><!-- --></A><H3>
isPersistPublishedItems</H3>
<PRE>
public boolean <B>isPersistPublishedItems</B>()</PRE>
<DL>
<DD>Returns true if items are going to be persisted in a storage. Note that when the
 variable is false then the last published item is the only items being saved
 to the backend storage.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if items are going to be persisted in a storage.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxPublishedItems()"><!-- --></A><H3>
getMaxPublishedItems</H3>
<PRE>
public int <B>getMaxPublishedItems</B>()</PRE>
<DL>
<DD>Returns the maximum number of published items to persist. Note that all nodes are going
 to persist their published items. The only difference is the number of the last published
 items to be persisted. Even nodes that are configured to not use persitent items are going
 to save the last published item.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the maximum number of published items to persist.</DL>
</DD>
</DL>
<HR>

<A NAME="isNotifyConfigChanges()"><!-- --></A><H3>
isNotifyConfigChanges</H3>
<PRE>
public boolean <B>isNotifyConfigChanges</B>()</PRE>
<DL>
<DD>Returns true if subscribers are going to be notified when node configuration changes.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if subscribers are going to be notified when node configuration changes.</DL>
</DD>
</DL>
<HR>

<A NAME="isNotifyDelete()"><!-- --></A><H3>
isNotifyDelete</H3>
<PRE>
public boolean <B>isNotifyDelete</B>()</PRE>
<DL>
<DD>Returns true if subscribers are going to be notified when node is deleted.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if subscribers are going to be notified when node is deleted.</DL>
</DD>
</DL>
<HR>

<A NAME="isNotifyRetract()"><!-- --></A><H3>
isNotifyRetract</H3>
<PRE>
public boolean <B>isNotifyRetract</B>()</PRE>
<DL>
<DD>Returns true if subscribers are going to be notified when items are removed from the node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if subscribers are going to be notified when items are removed from the node.</DL>
</DD>
</DL>
<HR>

<A NAME="isPresenceBasedDelivery()"><!-- --></A><H3>
isPresenceBasedDelivery</H3>
<PRE>
public boolean <B>isPresenceBasedDelivery</B>()</PRE>
<DL>
<DD>Returns true if notifications are going to be delivered only to available users.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if notifications are going to be delivered only to available users.</DL>
</DD>
</DL>
<HR>

<A NAME="isSendItemSubscribe()"><!-- --></A><H3>
isSendItemSubscribe</H3>
<PRE>
public boolean <B>isSendItemSubscribe</B>()</PRE>
<DL>
<DD>Returns true if new subscribers are going to receive new items once subscribed.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if new subscribers are going to receive new items once subscribed.</DL>
</DD>
</DL>
<HR>

<A NAME="getPublisherModel()"><!-- --></A><H3>
getPublisherModel</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/models/PublisherModel.html" title="class in org.jivesoftware.openfire.pubsub.models">PublisherModel</A> <B>getPublisherModel</B>()</PRE>
<DL>
<DD>Returnes the publisher model that specifies who is allowed to publish items to the node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the publisher model that specifies who is allowed to publish items to the node.</DL>
</DD>
</DL>
<HR>

<A NAME="isSubscriptionEnabled()"><!-- --></A><H3>
isSubscriptionEnabled</H3>
<PRE>
public boolean <B>isSubscriptionEnabled</B>()</PRE>
<DL>
<DD>Returns true if subscribing and unsubscribing are enabled.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if subscribing and unsubscribing are enabled.</DL>
</DD>
</DL>
<HR>

<A NAME="getAccessModel()"><!-- --></A><H3>
getAccessModel</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html" title="class in org.jivesoftware.openfire.pubsub.models">AccessModel</A> <B>getAccessModel</B>()</PRE>
<DL>
<DD>Returns the access model that specifies who is allowed to subscribe and retrieve items.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the access model that specifies who is allowed to subscribe and retrieve items.</DL>
</DD>
</DL>
<HR>

<A NAME="getLanguage()"><!-- --></A><H3>
getLanguage</H3>
<PRE>
public <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> <B>getLanguage</B>()</PRE>
<DL>
<DD>Returns the default language of the node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the default language of the node.</DL>
</DD>
</DL>
<HR>

<A NAME="getReplyPolicy()"><!-- --></A><H3>
getReplyPolicy</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.ItemReplyPolicy.html" title="enum in org.jivesoftware.openfire.pubsub">Node.ItemReplyPolicy</A> <B>getReplyPolicy</B>()</PRE>
<DL>
<DD>Returns the policy that defines whether owners or publisher should receive
 replies to items.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the policy that defines whether owners or publisher should receive