privacylistmanager.html

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

 
<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="getInstance()"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyListManager.html" title="class in org.jivesoftware.openfire.privacy">PrivacyListManager</A> <B>getInstance</B>()</PRE>
<DL>
<DD>Returns the unique instance of this class.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the unique instance of this class.</DL>
</DD>
</DL>
<HR>

<A NAME="createPrivacyList(java.lang.String, java.lang.String, org.dom4j.Element)"><!-- --></A><H3>
createPrivacyList</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A> <B>createPrivacyList</B>(<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;username,
                                     <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;listName,
                                     org.dom4j.Element&nbsp;listElement)</PRE>
<DL>
<DD>Creates a new privacy list for the specified user.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the list owner.<DD><CODE>listName</CODE> - the name of the new privacy list.<DD><CODE>listElement</CODE> - the XML that specifies the list and its items.
<DT><B>Returns:</B><DD>the newly created PrivacyList.</DL>
</DD>
</DL>
<HR>

<A NAME="deletePrivacyList(java.lang.String, java.lang.String)"><!-- --></A><H3>
deletePrivacyList</H3>
<PRE>
public void <B>deletePrivacyList</B>(<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;username,
                              <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;listName)</PRE>
<DL>
<DD>Deletes an existing privacy list of a user. If the privacy list being deleted was
 the default list then the user will end up with no default list. Therefore, the user
 will have to set a new default list.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the list owner.<DD><CODE>listName</CODE> - the name of the list being deleted.</DL>
</DD>
</DL>
<HR>

<A NAME="deletePrivacyLists(java.lang.String)"><!-- --></A><H3>
deletePrivacyLists</H3>
<PRE>
public void <B>deletePrivacyLists</B>(<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;username)</PRE>
<DL>
<DD>Deletes all privacy lists of a user. This may be necessary when a user is being
 deleted from the system.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the list owner.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultPrivacyList(java.lang.String)"><!-- --></A><H3>
getDefaultPrivacyList</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A> <B>getDefaultPrivacyList</B>(<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;username)</PRE>
<DL>
<DD>Returns the default privacy list of the specified user or <tt>null</tt> if
 none was found.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the name of the user to get his default list.
<DT><B>Returns:</B><DD>the default privacy list of the specified user or <tt>null</tt> if
         none was found.</DL>
</DD>
</DL>
<HR>

<A NAME="getPrivacyList(java.lang.String, java.lang.String)"><!-- --></A><H3>
getPrivacyList</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A> <B>getPrivacyList</B>(<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;username,
                                  <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;listName)</PRE>
<DL>
<DD>Returns a specific privacy list of the specified user or <tt>null</tt> if
 none was found.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the name of the user to get his privacy list.<DD><CODE>listName</CODE> - the name of the list to get.
<DT><B>Returns:</B><DD>a privacy list of the specified user or <tt>null</tt> if
         none was found.</DL>
</DD>
</DL>
<HR>

<A NAME="changeDefaultList(java.lang.String, org.jivesoftware.openfire.privacy.PrivacyList, org.jivesoftware.openfire.privacy.PrivacyList)"><!-- --></A><H3>
changeDefaultList</H3>
<PRE>
public void <B>changeDefaultList</B>(<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;username,
                              <A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A>&nbsp;newDefault,
                              <A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyList.html" title="class in org.jivesoftware.openfire.privacy">PrivacyList</A>&nbsp;oldDefault)</PRE>
<DL>
<DD>Sets a given privacy list as the new default list of the user.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the name of the user that is setting a new default list.<DD><CODE>newDefault</CODE> - the new default privacy list.<DD><CODE>oldDefault</CODE> - the previous privacy list or <tt>null</tt> if no default list existed.</DL>
</DD>
</DL>
<HR>

<A NAME="addListener(org.jivesoftware.openfire.privacy.PrivacyListEventListener)"><!-- --></A><H3>
addListener</H3>
<PRE>
public void <B>addListener</B>(<A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyListEventListener.html" title="interface in org.jivesoftware.openfire.privacy">PrivacyListEventListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Registers a listener to receive events when a privacy list is created, updated or deleted.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener.</DL>
</DD>
</DL>
<HR>

<A NAME="removeListener(org.jivesoftware.openfire.privacy.PrivacyListEventListener)"><!-- --></A><H3>
removeListener</H3>
<PRE>
public void <B>removeListener</B>(<A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyListEventListener.html" title="interface in org.jivesoftware.openfire.privacy">PrivacyListEventListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Unregisters a listener to receive events.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener.</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/privacy/PrivacyListEventListener.html" title="interface in org.jivesoftware.openfire.privacy"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/privacy/PrivacyListProvider.html" title="class in org.jivesoftware.openfire.privacy"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/privacy/PrivacyListManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PrivacyListManager.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;FIELD&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>