Class DefaultAbstractTurbineRole
- java.lang.Object
-
- org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity
-
- org.apache.fulcrum.security.torque.security.turbine.TorqueAbstractTurbineTurbineSecurityEntity
-
- org.apache.fulcrum.security.torque.turbine.DefaultAbstractTurbineRole
-
- All Implemented Interfaces:
Serializable
,Role
,SecurityEntity
,TurbineRole
,TurbineUserGroupRoleEntity
,org.apache.torque.om.ObjectModel
,org.apache.torque.om.Persistent
- Direct Known Subclasses:
BaseTurbineRole
public abstract class DefaultAbstractTurbineRole extends TorqueAbstractTurbineTurbineSecurityEntity implements TurbineRole
This abstract class provides the SecurityInterface to the managers.- Version:
- $Id:$
- Author:
- Thomas Vandahl
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultAbstractTurbineRole()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPermission(Permission permission)
This method should only be used by a RoleManager.void
delete()
Delete this entityPermissionSet
getPermissions()
Get the permission that are part of this role<T extends Permission>
Set<T>getPermissionsAsSet()
Get the permission that are part of this role as Setprotected <T extends TurbineRolePermissionPeerMapper>
List<T>getTurbineRolePermissionsJoinTurbinePermission(org.apache.torque.criteria.Criteria criteria, Connection con)
Forward reference to generated code Get a list of association objects, pre-populated with their TurbinePermission objects.protected <T extends TurbineUserGroupRoleModelPeerMapper>
List<T>getTurbineUserGroupRolesJoinTurbineGroup(org.apache.torque.criteria.Criteria criteria, Connection con)
Forward reference to generated code Get a list of association objects, pre-populated with their TurbineGroup objects.<T extends TurbineUserGroupRole>
Set<T>getUserGroupRoleSet()
Get the User/Group/Role set associated with this entityvoid
removePermission(Permission permission)
This method should only be used by a RoleManager.void
retrieveAttachedObjects(Connection con)
old contract, lazy is set tofalse
.void
retrieveAttachedObjects(Connection con, Boolean lazy)
Retrieve attached objects such as users, permissions, ...void
setPermissions(PermissionSet permissionSet)
Set the permission that are part of this role<T extends Permission>
voidsetPermissionsAsSet(Set<T> permissions)
Set the permission that are part of this role as Setvoid
update(Connection con)
Update this instance to the database with all dependent objects-
Methods inherited from class org.apache.fulcrum.security.torque.security.turbine.TorqueAbstractTurbineTurbineSecurityEntity
addUserGroupRole, addUserGroupRole, removeUserGroupRole, removeUserGroupRole, setUserGroupRoleSet
-
Methods inherited from class org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity
getEntityId, getEntityName, getId, getName, setEntityId, setEntityName, setId, setName
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.torque.om.ObjectModel
getPrimaryKey, isModified, isNew, setModified, setNew, setPrimaryKey, setPrimaryKey
-
Methods inherited from interface org.apache.fulcrum.security.entity.SecurityEntity
getId, getName, setId, setName
-
Methods inherited from interface org.apache.fulcrum.security.model.turbine.entity.TurbineUserGroupRoleEntity
addUserGroupRole, removeUserGroupRole, setUserGroupRoleSet
-
-
-
-
Constructor Detail
-
DefaultAbstractTurbineRole
public DefaultAbstractTurbineRole()
-
-
Method Detail
-
getTurbineRolePermissionsJoinTurbinePermission
protected <T extends TurbineRolePermissionPeerMapper> List<T> getTurbineRolePermissionsJoinTurbinePermission(org.apache.torque.criteria.Criteria criteria, Connection con) throws org.apache.torque.TorqueException
Forward reference to generated code Get a list of association objects, pre-populated with their TurbinePermission objects.- Parameters:
criteria
- Criteria to define the selection of recordscon
- a database connection- Returns:
- a list of Role/Permission relations
- Throws:
org.apache.torque.TorqueException
- if any database error occurs
-
getTurbineUserGroupRolesJoinTurbineGroup
protected <T extends TurbineUserGroupRoleModelPeerMapper> List<T> getTurbineUserGroupRolesJoinTurbineGroup(org.apache.torque.criteria.Criteria criteria, Connection con) throws org.apache.torque.TorqueException, DataBackendException
Forward reference to generated code Get a list of association objects, pre-populated with their TurbineGroup objects.- Parameters:
criteria
- Criteria to define the selection of recordscon
- a database connection- Returns:
- a list of User/Group/Role relations
- Throws:
org.apache.torque.TorqueException
- if any database error occursDataBackendException
-
addPermission
public void addPermission(Permission permission)
Description copied from interface:TurbineRole
This method should only be used by a RoleManager. Not directly.- Specified by:
addPermission
in interfaceTurbineRole
- Parameters:
permission
- perm to add- See Also:
TurbineRole.addPermission(org.apache.fulcrum.security.entity.Permission)
-
getPermissions
public PermissionSet getPermissions()
Description copied from interface:TurbineRole
Get the permission that are part of this role- Specified by:
getPermissions
in interfaceTurbineRole
- Returns:
- a set of permissions
- See Also:
TurbineRole.getPermissions()
-
getPermissionsAsSet
public <T extends Permission> Set<T> getPermissionsAsSet()
Description copied from interface:TurbineRole
Get the permission that are part of this role as Set- Specified by:
getPermissionsAsSet
in interfaceTurbineRole
- Returns:
- a set of permissions
- See Also:
TurbineRole.getPermissionsAsSet()
-
removePermission
public void removePermission(Permission permission)
Description copied from interface:TurbineRole
This method should only be used by a RoleManager. Not directly.- Specified by:
removePermission
in interfaceTurbineRole
- Parameters:
permission
- perm to remove- See Also:
TurbineRole.removePermission(org.apache.fulcrum.security.entity.Permission)
-
setPermissions
public void setPermissions(PermissionSet permissionSet)
Description copied from interface:TurbineRole
Set the permission that are part of this role- Specified by:
setPermissions
in interfaceTurbineRole
- Parameters:
permissionSet
- a set of permissions- See Also:
TurbineRole.setPermissions(org.apache.fulcrum.security.util.PermissionSet)
-
setPermissionsAsSet
public <T extends Permission> void setPermissionsAsSet(Set<T> permissions)
Description copied from interface:TurbineRole
Set the permission that are part of this role as Set- Specified by:
setPermissionsAsSet
in interfaceTurbineRole
- Type Parameters:
T
- Permission- Parameters:
permissions
- a set of permissions- See Also:
TurbineRole.setPermissionsAsSet(java.util.Set)
-
retrieveAttachedObjects
public void retrieveAttachedObjects(Connection con) throws DataBackendException
Description copied from class:TorqueAbstractSecurityEntity
old contract, lazy is set tofalse
.- Specified by:
retrieveAttachedObjects
in classTorqueAbstractSecurityEntity
- Parameters:
con
- A database connection- Throws:
DataBackendException
- wrapper exception: user information not found exception
-
retrieveAttachedObjects
public void retrieveAttachedObjects(Connection con, Boolean lazy) throws DataBackendException
Description copied from class:TorqueAbstractSecurityEntity
Retrieve attached objects such as users, permissions, ...- Specified by:
retrieveAttachedObjects
in classTorqueAbstractSecurityEntity
- Parameters:
con
- A database connectionlazy
- iftrue
, may load some or all relationships later- Throws:
DataBackendException
-
getUserGroupRoleSet
public <T extends TurbineUserGroupRole> Set<T> getUserGroupRoleSet() throws DataBackendException
Description copied from interface:TurbineUserGroupRoleEntity
Get the User/Group/Role set associated with this entity- Specified by:
getUserGroupRoleSet
in interfaceTurbineUserGroupRoleEntity
- Overrides:
getUserGroupRoleSet
in classTorqueAbstractTurbineTurbineSecurityEntity
- Type Parameters:
T
- TurbineUserGroupRole- Returns:
- a set of User/Group/Role relations
- Throws:
DataBackendException
- generic exception
-
update
public void update(Connection con) throws org.apache.torque.TorqueException
Description copied from class:TorqueAbstractSecurityEntity
Update this instance to the database with all dependent objects- Specified by:
update
in classTorqueAbstractSecurityEntity
- Parameters:
con
- A database connection- Throws:
org.apache.torque.TorqueException
- database not found exception
-
delete
public void delete() throws org.apache.torque.TorqueException
Description copied from class:TorqueAbstractSecurityEntity
Delete this entity- Specified by:
delete
in classTorqueAbstractSecurityEntity
- Throws:
org.apache.torque.TorqueException
- if any database error occurs if any database operation fails- See Also:
TorqueAbstractSecurityEntity.delete()
-
-