|
Jive Messenger 2.2.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupProvider
Provider interface for groups. Users that wish to integrate with their own group system must implement this class and then register the implementation with Jive Messenger in the jive-messenger.xml file. An entry in that file would look like the following:
<provider> <group> <className>com.foo.auth.CustomGroupProvider</className> </group> </provider>
Method Summary | |
---|---|
void |
addMember(String groupName,
String username,
boolean administrator)
Adds a user to a group (optional operation). |
Group |
createGroup(String name)
Creates a group with the given name (optional operation). |
void |
deleteGroup(String name)
Deletes the group (optional operation). |
void |
deleteMember(String groupName,
String username)
Deletes a user from a group (optional operation). |
Group |
getGroup(String name)
Returns a group based on it's name. |
int |
getGroupCount()
Returns the number of groups in the system. |
Collection<Group> |
getGroups()
Returns the Collection of all groups in the system. |
Collection<Group> |
getGroups(int startIndex,
int numResults)
Returns the Collection of all groups in the system. |
Collection<Group> |
getGroups(User user)
Returns the Collection of Groups that a user belongs to. |
boolean |
isReadOnly()
Returns true if this GroupProvider is read-only. |
void |
setDescription(String name,
String description)
Updates the group's description. |
void |
setName(String oldName,
String newName)
Sets the name of a group to a new name. |
void |
updateMember(String groupName,
String username,
boolean administrator)
Updates the privileges of a user in a group. |
Method Detail |
---|
Group createGroup(String name) throws UnsupportedOperationException, GroupAlreadyExistsException
The provider is responsible for setting the creation date and modification date to the current date/time.
name
- name of the group.
GroupAlreadyExistsException
- if a group with the same name already
exists.
UnsupportedOperationException
- if the provider does not
support the operation.void deleteGroup(String name) throws UnsupportedOperationException
name
- the name of the group to delete.
UnsupportedOperationException
- if the provider does not
support the operation.Group getGroup(String name) throws GroupNotFoundException
name
- the name of the group.
GroupNotFoundException
- If no group with that ID could be foundvoid setName(String oldName, String newName) throws UnsupportedOperationException, GroupAlreadyExistsException
oldName
- the current name of the group.newName
- the desired new name of the group.
GroupAlreadyExistsException
- if a group with the same name already
exists.
UnsupportedOperationException
- if the provider does not
support the operation.void setDescription(String name, String description) throws GroupNotFoundException
name
- the group name.description
- the group description.
GroupNotFoundException
- if no existing group could be found to update.int getGroupCount()
Collection<Group> getGroups()
Collection<Group> getGroups(int startIndex, int numResults)
startIndex
- start index in results.numResults
- number of results to return.
Collection<Group> getGroups(User user)
user
- the user.
void addMember(String groupName, String username, boolean administrator) throws UnsupportedOperationException
groupName
- the group to add the member tousername
- the username to addadministrator
- True if the member is an administrator of the group
UnsupportedOperationException
- if the provider does not
support the operation.void updateMember(String groupName, String username, boolean administrator) throws UnsupportedOperationException
groupName
- the group where the change happenedusername
- the username to of the user with new privilegesadministrator
- True if the member is an administrator of the group
UnsupportedOperationException
- if the provider does not
support the operation.void deleteMember(String groupName, String username) throws UnsupportedOperationException
groupName
- the group name.username
- the username.
UnsupportedOperationException
- if the provider does not
support the operation.boolean isReadOnly()
|
Jive Messenger 2.2.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |