rostermanager.html

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

<HR>

<A NAME="deleteRoster(org.xmpp.packet.JID)"><!-- --></A><H3>
deleteRoster</H3>
<PRE>
public void <B>deleteRoster</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD>Removes the entire roster of a given user. This is necessary when a user
 account is being deleted from the server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the user.</DL>
</DD>
</DL>
<HR>

<A NAME="getSharedGroups(java.lang.String)"><!-- --></A><H3>
getSharedGroups</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&gt; <B>getSharedGroups</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 a collection with all the groups that the user may include in his roster. The
 following criteria will be used to select the groups: 1) Groups that are configured so that
 everybody can include in his roster, 2) Groups that are configured so that its users may
 include the group in their rosters and the user is a group user of the group and 3) User
 belongs to a Group that may see a Group that whose members may include the Group in their
 rosters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the user to return his shared groups.
<DT><B>Returns:</B><DD>a collection with all the groups that the user may include in his roster.</DL>
</DD>
</DL>
<HR>

<A NAME="getPublicSharedGroups()"><!-- --></A><H3>
getPublicSharedGroups</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&gt; <B>getPublicSharedGroups</B>()</PRE>
<DL>
<DD>Returns the list of shared groups whose visibility is public.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the list of shared groups whose visibility is public.</DL>
</DD>
</DL>
<HR>

<A NAME="groupCreated(org.jivesoftware.openfire.group.Group, java.util.Map)"><!-- --></A><H3>
groupCreated</H3>
<PRE>
public void <B>groupCreated</B>(<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&nbsp;group,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#groupCreated(org.jivesoftware.openfire.group.Group, java.util.Map)">GroupEventListener</A></CODE></B></DD>
<DD>A group was created.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#groupCreated(org.jivesoftware.openfire.group.Group, java.util.Map)">groupCreated</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html" title="interface in org.jivesoftware.openfire.event">GroupEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group.<DD><CODE>params</CODE> - event parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="groupDeleting(org.jivesoftware.openfire.group.Group, java.util.Map)"><!-- --></A><H3>
groupDeleting</H3>
<PRE>
public void <B>groupDeleting</B>(<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&nbsp;group,
                          <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#groupDeleting(org.jivesoftware.openfire.group.Group, java.util.Map)">GroupEventListener</A></CODE></B></DD>
<DD>A group is being deleted.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#groupDeleting(org.jivesoftware.openfire.group.Group, java.util.Map)">groupDeleting</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html" title="interface in org.jivesoftware.openfire.event">GroupEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group.<DD><CODE>params</CODE> - event parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="groupModified(org.jivesoftware.openfire.group.Group, java.util.Map)"><!-- --></A><H3>
groupModified</H3>
<PRE>
public void <B>groupModified</B>(<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&nbsp;group,
                          <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#groupModified(org.jivesoftware.openfire.group.Group, java.util.Map)">GroupEventListener</A></CODE></B></DD>
<DD>A group's name, description, or an extended property was changed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#groupModified(org.jivesoftware.openfire.group.Group, java.util.Map)">groupModified</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html" title="interface in org.jivesoftware.openfire.event">GroupEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group.<DD><CODE>params</CODE> - event parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="initialize(org.jivesoftware.openfire.XMPPServer)"><!-- --></A><H3>
initialize</H3>
<PRE>
public void <B>initialize</B>(<A HREF="../../../../org/jivesoftware/openfire/XMPPServer.html" title="class in org.jivesoftware.openfire">XMPPServer</A>&nbsp;server)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#initialize(org.jivesoftware.openfire.XMPPServer)">BasicModule</A></CODE></B></DD>
<DD><p>Initializes the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this initialize() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#initialize(org.jivesoftware.openfire.XMPPServer)">initialize</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#initialize(org.jivesoftware.openfire.XMPPServer)">initialize</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>server</CODE> - the server hosting this module.</DL>
</DD>
</DL>
<HR>

<A NAME="isSharedGroup(org.jivesoftware.openfire.group.Group)"><!-- --></A><H3>
isSharedGroup</H3>
<PRE>
public static boolean <B>isSharedGroup</B>(<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&nbsp;group)</PRE>
<DL>
<DD>Returns true if the specified Group may be included in a user roster. The decision is made
 based on the group properties that are configurable through the Admin Console.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group to check if it may be considered a shared group.
<DT><B>Returns:</B><DD>true if the specified Group may be included in a user roster.</DL>
</DD>
</DL>
<HR>

<A NAME="isPublicSharedGroup(org.jivesoftware.openfire.group.Group)"><!-- --></A><H3>
isPublicSharedGroup</H3>
<PRE>
public static boolean <B>isPublicSharedGroup</B>(<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&nbsp;group)</PRE>
<DL>
<DD>Returns true if the specified Group may be seen by all users in the system. The decision
 is made based on the group properties that are configurable through the Admin Console.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group to check if it may be seen by all users in the system.
<DT><B>Returns:</B><DD>true if the specified Group may be seen by all users in the system.</DL>
</DD>
</DL>
<HR>

<A NAME="memberAdded(org.jivesoftware.openfire.group.Group, java.util.Map)"><!-- --></A><H3>
memberAdded</H3>
<PRE>
public void <B>memberAdded</B>(<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&nbsp;group,
                        <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#memberAdded(org.jivesoftware.openfire.group.Group, java.util.Map)">GroupEventListener</A></CODE></B></DD>
<DD>A member was added to a group.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#memberAdded(org.jivesoftware.openfire.group.Group, java.util.Map)">memberAdded</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html" title="interface in org.jivesoftware.openfire.event">GroupEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group.<DD><CODE>params</CODE> - event parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="memberRemoved(org.jivesoftware.openfire.group.Group, java.util.Map)"><!-- --></A><H3>
memberRemoved</H3>
<PRE>
public void <B>memberRemoved</B>(<A HREF="../../../../org/jivesoftware/openfire/group/Group.html" title="class in org.jivesoftware.openfire.group">Group</A>&nbsp;group,
                          <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#memberRemoved(org.jivesoftware.openfire.group.Group, java.util.Map)">GroupEventListener</A></CODE></B></DD>
<DD>A member was removed from a group.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html#memberRemoved(org.jivesoftware.openfire.group.Group, java.util.Map)">memberRemoved</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/event/GroupEventListener.html" title="interface in org.jivesoftware.openfire.event">GroupEventListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - the group.<DD><CODE>params</CODE> - event parameters.</DL>
</DD>