whitelistaccess.html

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

&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>

<!-- ============ 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="canSubscribe(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID, org.xmpp.packet.JID)"><!-- --></A><H3>
canSubscribe</H3>
<PRE>
public boolean <B>canSubscribe</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;owner,
                            <A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;subscriber)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#canSubscribe(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID, org.xmpp.packet.JID)">AccessModel</A></CODE></B></DD>
<DD>Returns true if the entity is allowed to subscribe to the specified node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#canSubscribe(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID, org.xmpp.packet.JID)">canSubscribe</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html" title="class in org.jivesoftware.openfire.pubsub.models">AccessModel</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node that the subscriber is trying to subscribe to.<DD><CODE>owner</CODE> - the JID of the owner of the subscription.<DD><CODE>subscriber</CODE> - the JID of the subscriber.
<DT><B>Returns:</B><DD>true if the subscriber is allowed to subscribe to the specified node.</DL>
</DD>
</DL>
<HR>

<A NAME="canAccessItems(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID, org.xmpp.packet.JID)"><!-- --></A><H3>
canAccessItems</H3>
<PRE>
public boolean <B>canAccessItems</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;owner,
                              <A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;subscriber)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#canAccessItems(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID, org.xmpp.packet.JID)">AccessModel</A></CODE></B></DD>
<DD>Returns true if the entity is allowed to get the node published items.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#canAccessItems(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID, org.xmpp.packet.JID)">canAccessItems</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html" title="class in org.jivesoftware.openfire.pubsub.models">AccessModel</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node that the entity is trying to get the node's items.<DD><CODE>owner</CODE> - the JID of the owner of the subscription.<DD><CODE>subscriber</CODE> - the JID of the subscriber.
<DT><B>Returns:</B><DD>true if the subscriber is allowed to get the node's published items.</DL>
</DD>
</DL>
<HR>

<A NAME="getName()"><!-- --></A><H3>
getName</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>getName</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#getName()">AccessModel</A></CODE></B></DD>
<DD>Returns the name as defined by the JEP-60 spec.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#getName()">getName</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html" title="class in org.jivesoftware.openfire.pubsub.models">AccessModel</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the name as defined by the JEP-60 spec.</DL>
</DD>
</DL>
<HR>

<A NAME="getSubsriptionError()"><!-- --></A><H3>
getSubsriptionError</H3>
<PRE>
public <A HREF="../../../../../org/xmpp/packet/PacketError.Condition.html" title="enum in org.xmpp.packet">PacketError.Condition</A> <B>getSubsriptionError</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#getSubsriptionError()">AccessModel</A></CODE></B></DD>
<DD>Returns the error condition that should be returned to the subscriber when
 subscription is not allowed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#getSubsriptionError()">getSubsriptionError</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html" title="class in org.jivesoftware.openfire.pubsub.models">AccessModel</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the error condition that should be returned to the subscriber when
         subscription is not allowed.</DL>
</DD>
</DL>
<HR>

<A NAME="getSubsriptionErrorDetail()"><!-- --></A><H3>
getSubsriptionErrorDetail</H3>
<PRE>
public org.dom4j.Element <B>getSubsriptionErrorDetail</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#getSubsriptionErrorDetail()">AccessModel</A></CODE></B></DD>
<DD>Returns the error element that should be returned to the subscriber as
 error detail when subscription is not allowed. The returned element is created
 each time this message is sent so it is safe to include the returned element in
 the parent element.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#getSubsriptionErrorDetail()">getSubsriptionErrorDetail</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html" title="class in org.jivesoftware.openfire.pubsub.models">AccessModel</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the error element that should be returned to the subscriber as
         error detail when subscription is not allowed.</DL>
</DD>
</DL>
<HR>

<A NAME="isAuthorizationRequired()"><!-- --></A><H3>
isAuthorizationRequired</H3>
<PRE>
public boolean <B>isAuthorizationRequired</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#isAuthorizationRequired()">AccessModel</A></CODE></B></DD>
<DD>Returns true if the new subscription should be authorized by a node owner.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html#isAuthorizationRequired()">isAuthorizationRequired</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/AccessModel.html" title="class in org.jivesoftware.openfire.pubsub.models">AccessModel</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the new subscription should be authorized by a node owner.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/jivesoftware/openfire/pubsub/models/RosterAccess.html" title="class in org.jivesoftware.openfire.pubsub.models"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?org/jivesoftware/openfire/pubsub/models/WhitelistAccess.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="WhitelistAccess.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.jivesoftware.openfire.pubsub.models.AccessModel">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>