|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupService
GroupService provides an interface which may be used to remotely to access
server methods to manage groups. Most interactions are done with Group
objects.
These can be either RemoteGroup
or GroupBean
.
A RemoteGroup
is constructed by the service when information about a Group is
retrieved from the server. This type of Group is immutable.
A GroupBean
is constructed on the client by the consumer of the API.
It is used to describe a server-side Group that you would like to update or create.
Method Summary | |
---|---|
boolean |
canManage()
Tests whether the current user can manage groups on this SDD instance as determined by their policies |
RemoteGroup |
create(GroupBean groupBean)
Creates a new group on the server as described by the GroupBean |
void |
delete(Group group)
Deletes the specified group from the server as determined by the Group |
boolean |
exists(GroupBean groupBean)
Tests whether the specified group exists on the server |
RemoteGroup |
get(GroupBean groupBean)
Retrieves a group from the server as described by the GroupBean . |
java.util.List |
getAll()
Returns all the Group objects currently available on the server |
java.util.List |
getUserGroups(User user)
Gets all the groups that a given user is in |
boolean |
isUserInGroup(User user,
Group group)
Tests whether the specified User is in the given Group |
RemoteGroup |
update(GroupBean groupBean)
Updates the group on the server with the parameters of the provided GroupBean . |
Method Detail |
---|
boolean canManage() throws InvalidSessionException, RemoteException
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if a session has expiredRemoteGroup create(GroupBean groupBean) throws InvalidSessionException, InsufficientPrivilegesException, InvalidGroupException, InvalidUserException, RemoteException, InvalidGroupBeanException
GroupBean
groupBean
- The GroupBean to be created on the server
InvalidSessionException
- if a session has expired
InsufficientPrivilegesException
- if the user does not have the policy to manage groups
InvalidGroupException
- if the group to be created does not meet group/description naming criteria
InvalidUserException
- if the group has invalid members
RemoteException
- if a server or transport error occurs
InvalidGroupBeanException
- if the GroupBean is missing a required valueRemoteGroup get(GroupBean groupBean) throws InvalidSessionException, InsufficientPrivilegesException, InvalidGroupException, RemoteException, InvalidGroupBeanException
GroupBean
.
The name property of the group is used to find the appropriate Group on the server
groupBean
- The GroupBean to get from the server
InvalidSessionException
- if a session has expired
InsufficientPrivilegesException
- if the user does not have the policy to manage groups
RemoteException
- if a server or transport error occurs
InvalidGroupException
- if the group does not exist
InvalidGroupBeanException
- if the GroupBean is missing a required valueRemoteGroup update(GroupBean groupBean) throws InvalidSessionException, InsufficientPrivilegesException, InvalidGroupException, InvalidUserException, RemoteException, ObjectModifiedException, InvalidGroupBeanException
GroupBean
.
The name property of the group is used to match to the appropriate Group on the server.
groupBean
- The GroupBean to update on the server
InvalidSessionException
- if a session has expired
InsufficientPrivilegesException
- if the user does not have the policy to manage groups
InvalidGroupException
- if the group to be updated does not meet group/description naming criteria
InvalidUserException
- if the group has invalid members
RemoteException
- if a server or transport error occurs
ObjectModifiedException
- if the group was modified on the server while the
user was editing it
InvalidGroupBeanException
- if the GroupBean is missing a required valuevoid delete(Group group) throws InvalidSessionException, InsufficientPrivilegesException, InvalidGroupException, RemoteException
Group
group
- The Group to delete on the server
InvalidSessionException
- if a session has expired
InsufficientPrivilegesException
- if the user does not have the policy to manage groups
InvalidGroupException
- if the group does not exist.
RemoteException
- if a server or transport error occursjava.util.List getAll() throws InvalidSessionException, InsufficientPrivilegesException, RemoteException
Group
objects currently available on the server
InvalidSessionException
- if a session has expired
InsufficientPrivilegesException
- if the user does not have the policy to manage groups
RemoteException
- if a server or transport error occursboolean exists(GroupBean groupBean) throws InvalidSessionException, InsufficientPrivilegesException, RemoteException, InvalidGroupBeanException
groupBean
- The GroupBean to test for
InvalidSessionException
- if a session has expired
InsufficientPrivilegesException
- if the user does not have the policy to manage groups
RemoteException
- if a server or transport error occurs
InvalidGroupBeanException
- if the GroupBean is missing a required valueboolean isUserInGroup(User user, Group group) throws InvalidSessionException, InsufficientPrivilegesException, RemoteException, InvalidGroupException, InvalidUserException
User
is in the given Group
user
- The user to testgroup
- The group to check if the user is in
InvalidSessionException
- if a session has expired
InsufficientPrivilegesException
- if the user does not have the policy to manage groups
RemoteException
- if a server or transport error occurs
InvalidGroupException
- if the specified group doesn't exist
InvalidUserException
- if the specified user doesn't existjava.util.List getUserGroups(User user) throws InvalidSessionException, InsufficientPrivilegesException, RemoteException, InvalidUserException
user
- the user to search for
InvalidSessionException
- if the session is invalid
InsufficientPrivilegesException
- if the user doesn't have the policy to manage groups
RemoteException
- if a server or transport error occurs
InvalidUserException
- if the specified user doesn't exist
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |