public interface GroupManager
Group
objects related tasks on behalf of the
BaseSecurityService
.
The responsibilities of this class include loading data of an group from the
storage and putting them into the
Group
objects, saving those data
to the permanent storage.Modifier and Type | Field and Description |
---|---|
static String |
ROLE
Avalon role - used to id the component within the manager
|
Modifier and Type | Method and Description |
---|---|
<T extends Group> |
addGroup(T group)
Creates a new group with specified attributes.
|
boolean |
checkExists(Group group)
Determines if the
Group exists in the security system. |
boolean |
checkExists(String group)
Determines if a
Group exists in the security system with the
specified name. |
GroupSet |
getAllGroups()
Retrieves all groups defined in the system.
|
<T extends Group> |
getGroupById(Object id)
Retrieve a Group object with specified Id.
|
<T extends Group> |
getGroupByName(String name)
Retrieve a Group object with specified name.
|
<T extends Group> |
getGroupInstance()
Construct a blank Group object.
|
<T extends Group> |
getGroupInstance(String groupName)
Construct a blank Group object.
|
void |
removeGroup(Group group)
Removes a Group from the system.
|
void |
renameGroup(Group group,
String name)
Renames an existing Group.
|
static final String ROLE
<T extends Group> T getGroupInstance() throws DataBackendException
DataBackendException
- if the object could not be instantiated.<T extends Group> T getGroupInstance(String groupName) throws DataBackendException
groupName
- The name of the GroupDataBackendException
- if the object could not be instantiated.<T extends Group> T getGroupByName(String name) throws DataBackendException, UnknownEntityException
name
- the name of the Group.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.<T extends Group> T getGroupById(Object id) throws DataBackendException, UnknownEntityException
name
- the name of the Group.UnknownEntityException
- if the permission does not exist in the database.DataBackendException
- if there is a problem accessing the storage.void renameGroup(Group group, String name) throws DataBackendException, UnknownEntityException
group
- The object describing the group to be renamed.name
- the new name for the group.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.void removeGroup(Group group) throws DataBackendException, UnknownEntityException
group
- The object describing the group to be removed.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.<T extends Group> T addGroup(T group) throws DataBackendException, EntityExistsException
group
- the object describing the group to be created.DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the group already exists.GroupSet getAllGroups() throws DataBackendException
DataBackendException
- if there was an error accessing the data backend.boolean checkExists(Group group) throws DataBackendException
Group
exists in the security system.permission
- a Group
valueDataBackendException
- when more than one group with the same name exists.Exception
- A generic exception.boolean checkExists(String group) throws DataBackendException
Group
exists in the security system with the
specified name.groupName
- the name of a Group
to check.DataBackendException
- when more than one group with the same name exists.Exception
- A generic exception.Copyright © 2011-2015 The Apache Software Foundation. All Rights Reserved.