|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.crowd.service.cache.CachingGroupManager
public class CachingGroupManager
Handles group names & groups themselves.
Constructor Summary | |
---|---|
CachingGroupManager(SecurityServerClient securityServerClient,
BasicCache basicCache)
|
Method Summary | |
---|---|
SOAPGroup |
addGroup(SOAPGroup group)
Adds group to the Crowd server. |
List |
getAllGroupNames()
Returns a list of all available groups. |
SOAPGroup |
getGroup(String groupName)
See also CachingGroupMembershipManager.getMembers(String) } for similar logic. |
boolean |
isGroup(String groupName)
Returns true if groupName represents a valid group, false otherwise. |
void |
removeGroup(String groupName)
Removes a group from Crowd. |
List |
searchGroups(SearchRestriction[] restrictions)
Searches the list of all available groups based on the passed-in restrictions and returns a list
of groups that match. |
void |
updateGroup(SOAPGroup group)
Updates a group's details in Crowd. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CachingGroupManager(SecurityServerClient securityServerClient, BasicCache basicCache)
Method Detail |
---|
public boolean isGroup(String groupName) throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException
GroupManager
groupName
represents a valid group, false otherwise.
isGroup
in interface GroupManager
groupName
- The name to check
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
InvalidAuthenticationException
- application authentication is not validpublic SOAPGroup getGroup(String groupName) throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException, GroupNotFoundException
CachingGroupMembershipManager.getMembers(String)
} for similar logic.
getGroup
in interface GroupManager
groupName
- The name of the group to fetch
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
InvalidAuthenticationException
- application authentication is not valid
GroupNotFoundException
- The group could not be found.public SOAPGroup addGroup(SOAPGroup group) throws RemoteException, InvalidGroupException, InvalidAuthorizationTokenException, ApplicationPermissionException, InvalidAuthenticationException
GroupManager
group
to the Crowd server.
addGroup
in interface GroupManager
group
- The object containing the details of the group.
SOAPGroup
, as returned by the Crowd server.
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidGroupException
- Could not add the group - it may be malformed, or a group with that name may already exist.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
ApplicationPermissionException
- The application does not have permission to add groups.
InvalidAuthenticationException
- application authentication is not validpublic List searchGroups(SearchRestriction[] restrictions) throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException
GroupManager
restrictions
and returns a list
of groups that match.
searchGroups
in interface GroupManager
restrictions
- search restrictions
List
of SOAPGroup
s that match the criteria.
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
InvalidAuthenticationException
- application authentication is not validpublic void updateGroup(SOAPGroup group) throws RemoteException, ApplicationPermissionException, InvalidAuthorizationTokenException, InvalidAuthenticationException, GroupNotFoundException
GroupManager
updateGroup
in interface GroupManager
group
- The group to update
RemoteException
- A communication error occurred - the Crowd server may not be available.
ApplicationPermissionException
- The application does not have permission to update groups.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
InvalidAuthenticationException
- application authentication is not valid
GroupNotFoundException
- The group to update could not be found.public void removeGroup(String groupName) throws RemoteException, InvalidAuthorizationTokenException, ApplicationPermissionException, InvalidAuthenticationException, GroupNotFoundException
GroupManager
removeGroup
in interface GroupManager
groupName
- The name of the group to remove.
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
ApplicationPermissionException
- The application does not have permission to remove groups.
InvalidAuthenticationException
- application authentication is not valid
GroupNotFoundException
- The group to remove could not be found.public List getAllGroupNames() throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException
GroupManager
getAllGroupNames
in interface GroupManager
List
of String
s that list all the groups visible to this application.
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
InvalidAuthenticationException
- application authentication is not valid
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |