Package org.apache.fulcrum.security.torque.turbine

Class FulcrumAbstractTurbineRole

java.lang.Object

org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity

org.apache.fulcrum.security.torque.security.turbine.TorqueAbstractTurbineTurbineSecurityEntity

org.apache.fulcrum.security.torque.turbine.FulcrumAbstractTurbineRole

All Implemented Interfaces:

Serializable, Role, SecurityEntity, TurbineRole, TurbineUserGroupRoleEntity, org.apache.torque.om.ObjectModel, org.apache.torque.om.Persistent

Direct Known Subclasses:

BaseTorqueTurbineRole

public abstract class FulcrumAbstractTurbineRole
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
FulcrumAbstractTurbineRole()

Method Summary

Modifier and Type	Method	Description
void	addPermission(Permission permission)
void	delete()	Delete this entity
String	getDatabaseName()
PermissionSet	getPermissions()
<T extends Permission> Set<T>	getPermissionsAsSet()
<T extends TurbineUserGroupRole> Set<T>	getUserGroupRoleSet()
void	removePermission(Permission permission)
void	retrieveAttachedObjects(Connection con)	old contract, lazy is set to false.
void	retrieveAttachedObjects(Connection con, Boolean lazy)	Retrieve attached objects such as users, permissions, ...
void	setPermissions(PermissionSet permissionSet)
<T extends Permission> void	setPermissionsAsSet(Set<T> permissions)
void	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

equals, 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.torque.om.Persistent

save, save, save

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

FulcrumAbstractTurbineRole

public FulcrumAbstractTurbineRole()

Method Detail

addPermission

public void addPermission(Permission permission)

Specified by:

addPermission in interface TurbineRole

getPermissions

public PermissionSet getPermissions()

Specified by:

getPermissions in interface TurbineRole

getPermissionsAsSet

public <T extends Permission> Set<T> getPermissionsAsSet()

Specified by:

getPermissionsAsSet in interface TurbineRole

removePermission

public void removePermission(Permission permission)

Specified by:

removePermission in interface TurbineRole

setPermissions

public void setPermissions(PermissionSet permissionSet)

Specified by:

setPermissions in interface TurbineRole

setPermissionsAsSet

public <T extends Permission> void setPermissionsAsSet(Set<T> permissions)

Specified by:

setPermissionsAsSet in interface TurbineRole

getDatabaseName

public String getDatabaseName()

Returns:

the database name

retrieveAttachedObjects

public void retrieveAttachedObjects(Connection con)
                             throws DataBackendException

Description copied from class: TorqueAbstractSecurityEntity

old contract, lazy is set to false.

Specified by:

retrieveAttachedObjects in class TorqueAbstractSecurityEntity

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 class TorqueAbstractSecurityEntity

Parameters:

con - A database connection

lazy - if true, may load some or all relationships later

Throws:

DataBackendException

getUserGroupRoleSet

public <T extends TurbineUserGroupRole> Set<T> getUserGroupRoleSet()
                                                            throws DataBackendException

Specified by:

getUserGroupRoleSet in interface TurbineUserGroupRoleEntity

Overrides:

getUserGroupRoleSet in class TorqueAbstractTurbineTurbineSecurityEntity

Throws:

DataBackendException

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 class TorqueAbstractSecurityEntity

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 class TorqueAbstractSecurityEntity

Throws:

org.apache.torque.TorqueException - if any database error occurs if any database operation fails