Class TorqueAbstractRoleManager
java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.fulcrum.security.spi.AbstractManager
org.apache.fulcrum.security.spi.AbstractEntityManager
org.apache.fulcrum.security.spi.AbstractRoleManager
org.apache.fulcrum.security.torque.TorqueAbstractRoleManager
- All Implemented Interfaces:
Serializable,org.apache.avalon.framework.activity.Disposable,org.apache.avalon.framework.configuration.Configurable,org.apache.avalon.framework.logger.LogEnabled,org.apache.avalon.framework.service.Serviceable,org.apache.avalon.framework.thread.ThreadSafe,RoleManager,LazyLoadable
- Direct Known Subclasses:
PeerRoleManager,TorqueDynamicRoleManagerImpl
This implementation persists to a database via Torque.
- Version:
- $Id:$
- Author:
- Thomas Vandahl
- See Also:
-
Field Summary
FieldsFields inherited from class org.apache.fulcrum.security.spi.AbstractManager
managerFields inherited from interface org.apache.fulcrum.security.RoleManager
ROLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleancheckExists(String roleName) Determines if theRoleexists in the security system.voidconfigure(org.apache.avalon.framework.configuration.Configuration conf) Avalon Service lifecycle methodGet all specialized Rolesprotected abstract <T extends Role>
TdoSelectById(Integer id, Connection con) Get a specialized Role by idprotected abstract <T extends Role>
TdoSelectByName(String name, Connection con) Get a specialized Role by nameRetrieves all roles defined in the system.<T extends Role>
TgetRoleById(Object id) Retrieve a Role object with specified id.<T extends Role>
TgetRoleByName(String name) Retrieve a Role object with specified name.protected <T extends Role>
TpersistNewRole(T role) Creates a new role with specified attributes.voidremoveRole(Role role) Removes a Role from the system.voidrenameRole(Role role, String name) Renames an existing Role.voidsetLazyLoading(Boolean lazyLoading) Methods inherited from class org.apache.fulcrum.security.spi.AbstractRoleManager
addRole, checkExists, getRoleInstance, getRoleInstanceMethods inherited from class org.apache.fulcrum.security.spi.AbstractEntityManager
getClassName, setClassNameMethods inherited from class org.apache.fulcrum.security.spi.AbstractManager
dispose, getGroupManager, getPermissionManager, getRoleManager, getServiceManager, getUserManager, release, resolve, serviceMethods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
-
Field Details
-
lazyLoading
-
-
Constructor Details
-
TorqueAbstractRoleManager
public TorqueAbstractRoleManager()
-
-
Method Details
-
configure
public void configure(org.apache.avalon.framework.configuration.Configuration conf) throws org.apache.avalon.framework.configuration.ConfigurationException Avalon Service lifecycle method- Specified by:
configurein interfaceorg.apache.avalon.framework.configuration.Configurable- Overrides:
configurein classAbstractEntityManager- Throws:
org.apache.avalon.framework.configuration.ConfigurationException
-
doSelectAllRoles
protected abstract <T extends Role> List<T> doSelectAllRoles(Connection con) throws org.apache.torque.TorqueException Get all specialized Roles- Parameters:
con- a database connection- Returns:
- a List of Role instances
- Throws:
org.apache.torque.TorqueException- if any database error occurs
-
doSelectByName
protected abstract <T extends Role> T doSelectByName(String name, Connection con) throws org.apache.torque.NoRowsException, org.apache.torque.TooManyRowsException, org.apache.torque.TorqueException Get a specialized Role by name- Parameters:
name- the name of the groupcon- a database connection- Returns:
- a Role instance
- Throws:
org.apache.torque.NoRowsException- if no such group existsorg.apache.torque.TooManyRowsException- if multiple groups with the given name existorg.apache.torque.TorqueException- if any database error occurs if any other database error occurs
-
doSelectById
protected abstract <T extends Role> T doSelectById(Integer id, Connection con) throws org.apache.torque.NoRowsException, org.apache.torque.TooManyRowsException, org.apache.torque.TorqueException Get a specialized Role by id- Parameters:
id- the id of the groupcon- a database connection- Returns:
- a Role instance
- Throws:
org.apache.torque.NoRowsException- if no such group existsorg.apache.torque.TooManyRowsException- if multiple groups with the given id existorg.apache.torque.TorqueException- if any database error occurs if any other database error occurs
-
renameRole
Renames an existing Role.- Specified by:
renameRolein interfaceRoleManager- Parameters:
role- The object describing the role to be renamed.name- the new name for the role.- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the role does not exist.
-
persistNewRole
Creates a new role with specified attributes.- Specified by:
persistNewRolein classAbstractRoleManager- Parameters:
role- the object describing the role to be created.- Returns:
- a new Role object that has id set up properly.
- Throws:
DataBackendException- if there was an error accessing the data backend.
-
removeRole
Removes a Role from the system.- Specified by:
removeRolein interfaceRoleManager- Parameters:
role- The object describing the role to be removed.- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the role does not exist.
-
checkExists
Determines if theRoleexists in the security system.- Specified by:
checkExistsin interfaceRoleManager- Parameters:
roleName- aRolevalue- Returns:
- true if the role name exists in the system, false otherwise
- Throws:
DataBackendException- when more than one Role with the same name exists.
-
getAllRoles
Retrieves all roles defined in the system.- Specified by:
getAllRolesin interfaceRoleManager- Returns:
- the names of all roles defined in the system.
- Throws:
DataBackendException- if there was an error accessing the data backend.
-
getRoleById
public <T extends Role> T getRoleById(Object id) throws DataBackendException, UnknownEntityException Retrieve a Role object with specified id.- Specified by:
getRoleByIdin interfaceRoleManager- Overrides:
getRoleByIdin classAbstractRoleManager- Parameters:
id- the id of the Role.- Returns:
- an object representing the Role with specified id.
- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the role does not exist.
-
getRoleByName
public <T extends Role> T getRoleByName(String name) throws DataBackendException, UnknownEntityException Retrieve a Role object with specified name.- Specified by:
getRoleByNamein interfaceRoleManager- Overrides:
getRoleByNamein classAbstractRoleManager- Parameters:
name- the name of the Role.- Returns:
- an object representing the Role with specified name.
- Throws:
DataBackendException- if there was an error accessing the data backend.UnknownEntityException- if the role does not exist.
-
getLazyLoading
- Specified by:
getLazyLoadingin interfaceLazyLoadable
-
setLazyLoading
- Specified by:
setLazyLoadingin interfaceLazyLoadable
-