Package org.apache.fulcrum.security
Schnittstelle GroupManager
- Alle Superschnittstellen:
Serializable
- Alle bekannten Implementierungsklassen:
AbstractGroupManager
A GroupManager performs
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.- Version:
- $Id$
- Autor:
- Eric Pugh
-
Feldübersicht
Felder -
Methodenübersicht
Modifizierer und TypMethodeBeschreibung<T extends Group>
TaddGroup
(T group) Creates a new group with specified attributes.boolean
checkExists
(String groupName) Determines if aGroup
exists in the security system with the specified name.boolean
checkExists
(Group group) Determines if theGroup
exists in the security system.Retrieves all groups defined in the system.<T extends Group>
TgetGroupById
(Object id) Retrieve a Group object with specified Id.<T extends Group>
TgetGroupByName
(String name) Retrieve a Group object with specified name.<T extends Group>
TConstruct a blank Group object.<T extends Group>
TgetGroupInstance
(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.
-
Felddetails
-
ROLE
Avalon role - used to id the component within the manager
-
-
Methodendetails
-
getGroupInstance
Construct a blank Group object. This method calls getGroupClass, and then creates a new object using the default constructor.- Typparameter:
T
- The group extendingGroup
- Gibt zurück:
- an object implementing Group interface.
- Löst aus:
DataBackendException
- if the object could not be instantiated.
-
getGroupInstance
Construct a blank Group object. This method calls getGroupClass, and then creates a new object using the default constructor.- Typparameter:
T
- The group of typeGroup
- Parameter:
groupName
- The name of the Group- Gibt zurück:
- an object implementing Group interface.
- Löst aus:
DataBackendException
- if the object could not be instantiated.
-
getGroupByName
Retrieve a Group object with specified name.- Typparameter:
T
- The group of typeGroup
- Parameter:
name
- the name of the Group.- Gibt zurück:
- an object representing the Group with specified name.
- Löst aus:
DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.
-
getGroupById
Retrieve a Group object with specified Id.- Typparameter:
T
- Group type- Parameter:
id
- the Id of the Group.- Gibt zurück:
- an object representing the Group with specified name.
- Löst aus:
UnknownEntityException
- if the permission does not exist in the database.DataBackendException
- if there is a problem accessing the storage.
-
renameGroup
Renames an existing Group.- Parameter:
group
- The object describing the group to be renamed.name
- the new name for the group.- Löst aus:
DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.
-
removeGroup
Removes a Group from the system.- Parameter:
group
- The object describing the group to be removed.- Löst aus:
DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.
-
addGroup
Creates a new group with specified attributes.- Typparameter:
T
-- Parameter:
group
- the object describing the group to be created.- Gibt zurück:
- the new Group object.
- Löst aus:
DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the group already exists.
-
getAllGroups
Retrieves all groups defined in the system.- Gibt zurück:
- the names of all groups defined in the system.
- Löst aus:
DataBackendException
- if there was an error accessing the data backend.
-
checkExists
Determines if theGroup
exists in the security system.- Parameter:
group
- aGroup
value- Gibt zurück:
- true if the group exists in the system, false otherwise
- Löst aus:
DataBackendException
- when more than one group with the same name exists.
-
checkExists
Determines if aGroup
exists in the security system with the specified name.- Parameter:
groupName
- the name of aGroup
to check.- Gibt zurück:
- true if the group exists in the system, false otherwise
- Löst aus:
DataBackendException
- when more than one group with the same name exists.
-