Jive Messenger 2.2.2 Javadoc

org.jivesoftware.messenger.roster
Class RosterManager

java.lang.Object
  extended by org.jivesoftware.messenger.container.BasicModule
      extended by org.jivesoftware.messenger.roster.RosterManager
All Implemented Interfaces:
Module, GroupEventListener

public class RosterManager
extends BasicModule
implements GroupEventListener

A simple service that allows components to retrieve a roster based solely on the ID of the owner. Users have convenience methods for obtaining a roster associated with the owner. However there are many components that need to retrieve the roster based solely on the generic ID owner key. This interface defines a service that can do that. This allows classes that generically manage resource for resource owners (such as presence updates) to generically offer their services without knowing or caring if the roster owner is a user, chatbot, etc.

Author:
Iain Shigeoka

Constructor Summary
RosterManager()
           
 
Method Summary
 void adminAdded(Group group, Map params)
          An administrator was added to a group.
 void adminRemoved(Group group, Map params)
          An administrator was removed from a group.
 void deleteRoster(JID user)
          Removes the entire roster of a given user.
 Roster getRoster(String username)
          Returns the roster for the given username.
 Collection<Group> getSharedGroups(User user)
          Returns a collection with all the groups that the user may include in his roster.
 void groupCreated(Group group, Map params)
          A group was created.
 void groupDeleting(Group group, Map params)
          A group is being deleted.
 void groupModified(Group group, Map params)
          A group's name, description, or an extended property was changed.
 boolean isSharedGroup(Group group)
          Returns true if the specified Group may be included in a user roster.
 void memberAdded(Group group, Map params)
          A member was added to a group.
 void memberRemoved(Group group, Map params)
          A member was removed from a group.
 
Methods inherited from class org.jivesoftware.messenger.container.BasicModule
destroy, getName, initialize, start, stop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RosterManager

public RosterManager()
Method Detail

getRoster

public Roster getRoster(String username)
                 throws UserNotFoundException
Returns the roster for the given username.

Parameters:
username - the username to search for.
Returns:
the roster associated with the ID.
Throws:
UserNotFoundException - if the ID does not correspond to a known entity on the server.

deleteRoster

public void deleteRoster(JID user)
Removes the entire roster of a given user. This is necessary when a user account is being deleted from the server.

Parameters:
user - the user.

getSharedGroups

public Collection<Group> getSharedGroups(User user)
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.

Parameters:
user - the user to return his shared groups.
Returns:
a collection with all the groups that the user may include in his roster.

groupCreated

public void groupCreated(Group group,
                         Map params)
Description copied from interface: GroupEventListener
A group was created.

Specified by:
groupCreated in interface GroupEventListener
Parameters:
group - the group.
params - event parameters.

groupDeleting

public void groupDeleting(Group group,
                          Map params)
Description copied from interface: GroupEventListener
A group is being deleted.

Specified by:
groupDeleting in interface GroupEventListener
Parameters:
group - the group.
params - event parameters.

groupModified

public void groupModified(Group group,
                          Map params)
Description copied from interface: GroupEventListener
A group's name, description, or an extended property was changed.

Specified by:
groupModified in interface GroupEventListener
Parameters:
group - the group.
params - event parameters.

isSharedGroup

public boolean isSharedGroup(Group group)
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.

Parameters:
group - the group to check if it may be considered a shared group.
Returns:
true if the specified Group may be included in a user roster.

memberAdded

public void memberAdded(Group group,
                        Map params)
Description copied from interface: GroupEventListener
A member was added to a group.

Specified by:
memberAdded in interface GroupEventListener
Parameters:
group - the group.
params - event parameters.

memberRemoved

public void memberRemoved(Group group,
                          Map params)
Description copied from interface: GroupEventListener
A member was removed from a group.

Specified by:
memberRemoved in interface GroupEventListener
Parameters:
group - the group.
params - event parameters.

adminAdded

public void adminAdded(Group group,
                       Map params)
Description copied from interface: GroupEventListener
An administrator was added to a group.

Specified by:
adminAdded in interface GroupEventListener
Parameters:
group - the group.
params - event parameters.

adminRemoved

public void adminRemoved(Group group,
                         Map params)
Description copied from interface: GroupEventListener
An administrator was removed from a group.

Specified by:
adminRemoved in interface GroupEventListener
Parameters:
group - the group.
params - event parameters.

Jive Messenger 2.2.2 Javadoc

Copyright © 1999-2004 Jive Software.