|
Jive Messenger 2.2.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.messenger.container.BasicModule
org.jivesoftware.messenger.roster.RosterManager
public class RosterManager
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.
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 |
---|
public RosterManager()
Method Detail |
---|
public Roster getRoster(String username) throws UserNotFoundException
username
- the username to search for.
UserNotFoundException
- if the ID does not correspond
to a known entity on the server.public void deleteRoster(JID user)
user
- the user.public Collection<Group> getSharedGroups(User user)
user
- the user to return his shared groups.
public void groupCreated(Group group, Map params)
GroupEventListener
groupCreated
in interface GroupEventListener
group
- the group.params
- event parameters.public void groupDeleting(Group group, Map params)
GroupEventListener
groupDeleting
in interface GroupEventListener
group
- the group.params
- event parameters.public void groupModified(Group group, Map params)
GroupEventListener
groupModified
in interface GroupEventListener
group
- the group.params
- event parameters.public boolean isSharedGroup(Group group)
group
- the group to check if it may be considered a shared group.
public void memberAdded(Group group, Map params)
GroupEventListener
memberAdded
in interface GroupEventListener
group
- the group.params
- event parameters.public void memberRemoved(Group group, Map params)
GroupEventListener
memberRemoved
in interface GroupEventListener
group
- the group.params
- event parameters.public void adminAdded(Group group, Map params)
GroupEventListener
adminAdded
in interface GroupEventListener
group
- the group.params
- event parameters.public void adminRemoved(Group group, Map params)
GroupEventListener
adminRemoved
in interface GroupEventListener
group
- the group.params
- event parameters.
|
Jive Messenger 2.2.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |