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

Class DefaultAbstractTurbineUser

java.lang.Object

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

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

org.apache.fulcrum.security.torque.security.turbine.TorqueAbstractTurbineTurbineSecurityEntityDefault

org.apache.fulcrum.security.torque.turbine.DefaultAbstractTurbineUser

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseTurbineUser

public abstract class DefaultAbstractTurbineUser
extends TorqueAbstractTurbineTurbineSecurityEntityDefault

This abstract class provides the SecurityInterface to the managers. An implementing class is required to implement User at least. Most probably the OM classes allow to implement TurbineUser, which includes User.

Version:

$Id:$

Author:

Thomas Vandahl

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultAbstractTurbineUser()

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete this entity
protected <T extends TurbineUserGroupRoleModelPeerMapper> List<T>	getTurbineUserGroupRolesJoinTurbineGroup(org.apache.torque.criteria.Criteria criteria, Connection con)	Forward reference to module generated code Get a list of association objects, pre-populated with their TurbineGroup objects.
void	retrieveAttachedObjects(Connection con)	old contract, lazy is set to false.
void	retrieveAttachedObjects(Connection con, Boolean lazy)	Retrieve attached objects such as users, permissions, ...
<T extends TurbineUserGroupRoleModelPeerMapper> void	retrieveAttachedObjects(Connection con, Boolean lazy, List<T> ugrs)	Retrieve attached objects for user: user-group-role relationship(s) This method is required if custom peers is activated for (user) manager, to allow the custom group/role in ACLFactory.getAccessControlList(org.apache.fulcrum.security.entity.User)
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, getUserGroupRoleSet, 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.torque.om.Persistent

save, save, save

Methods inherited from interface org.apache.fulcrum.security.model.turbine.entity.TurbineUserGroupRoleEntity

addUserGroupRole, getUserGroupRoleSet, removeUserGroupRole, setUserGroupRoleSet

Constructor Detail

DefaultAbstractTurbineUser

public DefaultAbstractTurbineUser()

Method Detail

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 module generated code Get a list of association objects, pre-populated with their TurbineGroup objects. Does intentionally not initialize the cache collTurbineUserGroupRoles for referenced objects. Be careful not to call any of the generated getTurbineUserGroupRoles methods in derived classes, the link Persistent.save() method otherwise might not update the right relationships.

Parameters:

criteria - Criteria to define the selection of records

con - a database connection

Returns:

a list of User/Group/Role relations

Throws:

DataBackendException

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

retrieveAttachedObjects

public <T extends TurbineUserGroupRoleModelPeerMapper> void retrieveAttachedObjects(Connection con,
                                                                                    Boolean lazy,
                                                                                    List<T> ugrs)
                                                                             throws DataBackendException,
                                                                                    org.apache.torque.TorqueException

Description copied from class: TorqueAbstractTurbineTurbineSecurityEntityDefault

Retrieve attached objects for user: user-group-role relationship(s) This method is required if custom peers is activated for (user) manager, to allow the custom group/role in ACLFactory.getAccessControlList(org.apache.fulcrum.security.entity.User)

Specified by:

retrieveAttachedObjects in class TorqueAbstractTurbineTurbineSecurityEntityDefault

Parameters:

con - A database connection

lazy - if true, fetches objects lazily

ugrs - The custom TurbineUserGroupRole set

Throws:

DataBackendException - if data connection or user information (table objects) not found

org.apache.torque.TorqueException

See Also:

TorqueAbstractTurbineTurbineSecurityEntityDefault.retrieveAttachedObjects(java.sql.Connection, java.lang.Boolean, java.util.List)

retrieveAttachedObjects

public void retrieveAttachedObjects(Connection con,
                                    Boolean lazy)
                             throws org.apache.torque.TorqueException,
                                    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:

org.apache.torque.TorqueException - database not found exception

DataBackendException

retrieveAttachedObjects

public void retrieveAttachedObjects(Connection con)
                             throws DataBackendException,
                                    org.apache.torque.TorqueException

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

org.apache.torque.TorqueException

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