adminmanager.html

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

<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="getAdminProvider()"><!-- --></A><H3>
getAdminProvider</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/admin/AdminProvider.html" title="interface in org.jivesoftware.openfire.admin">AdminProvider</A> <B>getAdminProvider</B>()</PRE>
<DL>
<DD>Returns the currently-installed AdminProvider. <b>Warning:</b> in virtually all
 cases the admin provider should not be used directly. Instead, the appropriate
 methods in AdminManager should be called. Direct access to the admin provider is
 only provided for special-case logic.
<P>
<DD><DL>

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

<A NAME="getInstance()"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/admin/AdminManager.html" title="class in org.jivesoftware.openfire.admin">AdminManager</A> <B>getInstance</B>()</PRE>
<DL>
<DD>Returns a singleton instance of AdminManager.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a AdminManager instance.</DL>
</DD>
</DL>
<HR>

<A NAME="refreshAdminAccounts()"><!-- --></A><H3>
refreshAdminAccounts</H3>
<PRE>
public void <B>refreshAdminAccounts</B>()</PRE>
<DL>
<DD>Refreshs the list of admin users from the provider.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAdminAccounts()"><!-- --></A><H3>
getAdminAccounts</H3>
<PRE>
public <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/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&gt; <B>getAdminAccounts</B>()</PRE>
<DL>
<DD>Returns the list of admin users from the provider.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The list of users with admin status.</DL>
</DD>
</DL>
<HR>

<A NAME="addAdminAccount(java.lang.String)"><!-- --></A><H3>
addAdminAccount</H3>
<PRE>
public void <B>addAdminAccount</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>Adds a new account to the list of Admin accounts, based off a username, which will be converted
 into a JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - Username of account to add to list of admins.</DL>
</DD>
</DL>
<HR>

<A NAME="addAdminAccount(org.xmpp.packet.JID)"><!-- --></A><H3>
addAdminAccount</H3>
<PRE>
public void <B>addAdminAccount</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD>Adds a new account to the list of Admin accounts, based off a JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - JID of account to add to list of admins.</DL>
</DD>
</DL>
<HR>

<A NAME="removeAdminAccount(java.lang.String)"><!-- --></A><H3>
removeAdminAccount</H3>
<PRE>
public void <B>removeAdminAccount</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>Removes an account from the list of Admin accounts, based off username, which will be converted
 to a JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - Username of user to remove from admin list.</DL>
</DD>
</DL>
<HR>

<A NAME="removeAdminAccount(org.xmpp.packet.JID)"><!-- --></A><H3>
removeAdminAccount</H3>
<PRE>
public void <B>removeAdminAccount</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD>Removes an account from the list of Admin accounts, based off JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - JID of user to remove from admin list.</DL>
</DD>
</DL>
<HR>

<A NAME="isUserAdmin(java.lang.String, boolean)"><!-- --></A><H3>
isUserAdmin</H3>
<PRE>
public boolean <B>isUserAdmin</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,
                           boolean&nbsp;allowAdminIfEmpty)</PRE>
<DL>
<DD>Returns true if the user is an admin.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - Username of user to check whether they are an admin or not.<DD><CODE>allowAdminIfEmpty</CODE> - Allows the "admin" user to log in if the adminList is empty.
<DT><B>Returns:</B><DD>True or false if user is an admin.</DL>
</DD>
</DL>
<HR>

<A NAME="isUserAdmin(org.xmpp.packet.JID, boolean)"><!-- --></A><H3>
isUserAdmin</H3>
<PRE>
public boolean <B>isUserAdmin</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid,
                           boolean&nbsp;allowAdminIfEmpty)</PRE>
<DL>
<DD>Returns true if the user is an admin.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - JID of user to check whether they are an admin or not.<DD><CODE>allowAdminIfEmpty</CODE> - Allows the "admin" user to log in if the adminList is empty.
<DT><B>Returns:</B><DD>True or false if user is an admin.</DL>
</DD>
</DL>
<HR>

<A NAME="clearAdminUsers()"><!-- --></A><H3>
clearAdminUsers</H3>
<PRE>
public void <B>clearAdminUsers</B>()</PRE>
<DL>
<DD>Clears the list of admin users.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setAdminUsers(java.util.List)"><!-- --></A><H3>
setAdminUsers</H3>
<PRE>
public void <B>setAdminUsers</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="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&gt;&nbsp;usernames)</PRE>
<DL>
<DD>Sets the list of admin users based off of a list of usernames.  Clears list first.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>usernames</CODE> - List of usernames to set as admins.</DL>
</DD>
</DL>
<HR>

<A NAME="setAdminJIDs(java.util.List)"><!-- --></A><H3>
setAdminJIDs</H3>
<PRE>
public void <B>setAdminJIDs</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/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&gt;&nbsp;jids)</PRE>
<DL>
<DD>Sets the list of admin users based off of a list of jids.  Clears list first.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jids</CODE> - List of jids to set as admins.</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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/admin/AdminProvider.html" title="interface in org.jivesoftware.openfire.admin"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/admin/AdminManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="AdminManager.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>