nodesubscription.html

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

<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.Type.html" title="enum in org.jivesoftware.openfire.pubsub">NodeSubscription.Type</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#getType()">getType</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns if the owner has subscribed to receive notification of new items only
 or of new nodes only.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#isActive()">isActive</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the subscription is active.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#isAuthorizationPending()">isAuthorizationPending</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the subscription needs to be approved by a node owner to become
 active.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#isConfigurationPending()">isConfigurationPending</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if configuration is required by the node and is still pending to
 be configured by the subscriber.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#isIncludingBody()">isIncludingBody</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether an entity wants to receive an XMPP message body in
 addition to the payload format.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#isUsingDigest()">isUsingDigest</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether an entity wants to receive digests (aggregations) of
 notifications or all notifications individually.</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/NodeSubscription.html#sendAuthorizationRequest()">sendAuthorizationRequest</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends an request to authorize the pending subscription to all owners.</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/NodeSubscription.html#sendAuthorizationRequest(org.xmpp.packet.JID)">sendAuthorizationRequest</A></B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;owner)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends an request to authorize the pending subscription to the specified owner.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#shouldDeliverNotifications()">shouldDeliverNotifications</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether an entity wants to receive or has disabled notifications.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.html#toString()">toString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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#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>

<!-- ============ 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="getNode()"><!-- --></A><H3>
getNode</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A> <B>getNode</B>()</PRE>
<DL>
<DD>Returns the node that holds this subscription.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the node that holds this subscription.</DL>
</DD>
</DL>
<HR>

<A NAME="getID()"><!-- --></A><H3>
getID</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>getID</B>()</PRE>
<DL>
<DD>Returns the ID that uniquely identifies the subscription of the user in the node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the ID that uniquely identifies the subscription of the user in the node.</DL>
</DD>
</DL>
<HR>

<A NAME="getJID()"><!-- --></A><H3>
getJID</H3>
<PRE>
public <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getJID</B>()</PRE>
<DL>
<DD>Returns the JID that is going to receive the event notifications. This JID can be the
 owner JID or a full JID if the owner wants to receive the notification at a particular
 resource.<p>

 Moreover, since subscriber and owner are separated it should be theorically possible to
 have a different owner JID (e.g. [e-mail]) and a subscriber JID
 (e.g. [e-mail]). Note that letting this case to happen may open the pubsub service
 to get spam or security problems. However, the pubsub service should avoid this case to
 happen.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the JID that is going to receive the event notifications.</DL>
</DD>
</DL>
<HR>

<A NAME="getOwner()"><!-- --></A><H3>
getOwner</H3>
<PRE>
public <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getOwner</B>()</PRE>
<DL>
<DD>Retuns the JID of the entity that owns this subscription. The owner entity will have
 a <A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeAffiliate.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>NodeAffiliate</CODE></A> for the owner JID. The owner may have more than one subscription
 with the node based on what this message
 <A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html#isMultipleSubscriptionsEnabled()"><CODE>Node.isMultipleSubscriptionsEnabled()</CODE></A>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>he JID of the entity that owns this subscription.</DL>
</DD>
</DL>
<HR>

<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.State.html" title="enum in org.jivesoftware.openfire.pubsub">NodeSubscription.State</A> <B>getState</B>()</PRE>
<DL>
<DD>Returns the current subscription state. Subscriptions with status of pending should be
 authorized by a node owner.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the current subscription state.</DL>
</DD>
</DL>
<HR>

<A NAME="isConfigurationPending()"><!-- --></A><H3>
isConfigurationPending</H3>
<PRE>
public boolean <B>isConfigurationPending</B>()</PRE>
<DL>
<DD>Returns true if configuration is required by the node and is still pending to
 be configured by the subscriber. Otherwise return false. Once a subscription is
 configured it might need to be approved by a node owner to become active.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if configuration is required by the node and is still pending to
         be configured by the subscriber.</DL>
</DD>
</DL>
<HR>

<A NAME="isAuthorizationPending()"><!-- --></A><H3>
isAuthorizationPending</H3>
<PRE>
public boolean <B>isAuthorizationPending</B>()</PRE>
<DL>
<DD>Returns true if the subscription needs to be approved by a node owner to become
 active. Until the subscription is not activated the subscriber will not receive
 event notifications.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the subscription needs to be approved by a node owner to become active.</DL>
</DD>
</DL>
<HR>

<A NAME="shouldDeliverNotifications()"><!-- --></A><H3>
shouldDeliverNotifications</H3>
<PRE>
public boolean <B>shouldDeliverNotifications</B>()</PRE>
<DL>
<DD>Returns whether an entity wants to receive or has disabled notifications.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true when notifications should be sent to the subscriber.</DL>
</DD>
</DL>
<HR>

<A NAME="isUsingDigest()"><!-- --></A><H3>
isUsingDigest</H3>
<PRE>
public boolean <B>isUsingDigest</B>()</PRE>
<DL>
<DD>Returns whether an entity wants to receive digests (aggregations) of
 notifications or all notifications individually.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true when an entity wants to receive digests (aggregations) of notifications.</DL>
</DD>
</DL>
<HR>

<A NAME="getDigestFrequency()"><!-- --></A><H3>
getDigestFrequency</H3>
<PRE>
public int <B>getDigestFrequency</B>()</PRE>
<DL>
<DD>Returns the minimum number of milliseconds between sending any two notification digests.
 Default is 24 hours.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the minimum number of milliseconds between sending any two notification digests.</DL>
</DD>
</DL>
<HR>

<A NAME="getExpire()"><!-- --></A><H3>
getExpire</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A> <B>getExpire</B>()</PRE>
<DL>
<DD>Returns the Date at which a leased subscription will end or has ended. A value of
 <tt>null</tt> means that the subscription will never expire.
<P>
<DD><DL>