Package org.apache.fulcrum.security.torque.dynamic

Class TorqueAbstractDynamicUser

java.lang.Object

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

org.apache.fulcrum.security.torque.dynamic.TorqueAbstractDynamicUser

All Implemented Interfaces:

Serializable, SecurityEntity, User, BasicUser, DynamicUser, org.apache.torque.om.ObjectModel, org.apache.torque.om.Persistent

Direct Known Subclasses:

BaseTorqueDynamicUser

public abstract class TorqueAbstractDynamicUser
extends TorqueAbstractSecurityEntity
implements DynamicUser

This abstract class provides the SecurityInterface to the managers.

Version:

$Id:$

Author:

Thomas Vandahl

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TorqueAbstractDynamicUser()

Method Summary

Modifier and Type	Method	Description
void	addGroup(Group group)	Add the group to the list of groups
void	delete()	Delete this entity
String	getDatabaseName()
<T extends User> Set<T>	getDelegatees()	Get the set of delegatees for this user
<T extends User> Set<T>	getDelegators()	Get the set of delegators for this user
GroupSet	getGroups()	Get the groups this user is part of
<T extends Group> Set<T>	getGroupsAsSet()	Get the groups this user is part of as a Set
protected List<TorqueDynamicUserDelegates>	getTorqueDynamicUserDelegatessRelatedByDelegateeUserIdJoinTorqueDynamicUserRelatedByDelegatorUserId(org.apache.torque.criteria.Criteria criteria, Connection con)	Forward reference to generated code Get a list of delegator association objects, pre-populated with their TorqueDynamicUserDelegates objects.
protected List<TorqueDynamicUserDelegates>	getTorqueDynamicUserDelegatessRelatedByDelegatorUserIdJoinTorqueDynamicUserRelatedByDelegateeUserId(org.apache.torque.criteria.Criteria criteria, Connection con)	Forward reference to generated code Get a list of delegatee association objects, pre-populated with their TorqueDynamicUserDelegates objects.
protected List<TorqueDynamicUserGroup>	getTorqueDynamicUserGroupsJoinTorqueDynamicGroup(org.apache.torque.criteria.Criteria criteria, Connection con)	Forward reference to generated code Get a list of association objects, pre-populated with their TorqueDynamicGroup objects.
void	removeGroup(Group group)	Remove the group from the list of groups
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 User> void	setDelegatees(Set<T> delegatees)	Set the delegatees for this user
<T extends User> void	setDelegators(Set<T> delegates)	Set the delegators for this user
void	setGroups(GroupSet groups)	Set the groups this user is part of
<T extends Group> void	setGroupsAsSet(Set<T> groups)	Set the groups this user is part of as a Set
void	update(Connection con)	Update this instance to the database with all dependent objects

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.entity.SecurityEntity

getId, getName, setId, setName

Methods inherited from interface org.apache.fulcrum.security.entity.User

getPassword, setPassword

Constructor Detail

TorqueAbstractDynamicUser

public TorqueAbstractDynamicUser()

Method Detail

getTorqueDynamicUserGroupsJoinTorqueDynamicGroup

protected List<TorqueDynamicUserGroup> getTorqueDynamicUserGroupsJoinTorqueDynamicGroup(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 TorqueDynamicGroup objects.

Parameters:

criteria - Criteria to define the selection of records

con - a database connection

Returns:

a list of User/Group relations

Throws:

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

getTorqueDynamicUserDelegatessRelatedByDelegateeUserIdJoinTorqueDynamicUserRelatedByDelegatorUserId

protected List<TorqueDynamicUserDelegates> getTorqueDynamicUserDelegatessRelatedByDelegateeUserIdJoinTorqueDynamicUserRelatedByDelegatorUserId(org.apache.torque.criteria.Criteria criteria,
                                                                                                                                               Connection con)
                                                                                                                                        throws org.apache.torque.TorqueException

Forward reference to generated code Get a list of delegator association objects, pre-populated with their TorqueDynamicUserDelegates objects.

Parameters:

criteria - Criteria to define the selection of records

con - a database connection

Returns:

a list of User/Delegator relations

Throws:

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

getTorqueDynamicUserDelegatessRelatedByDelegatorUserIdJoinTorqueDynamicUserRelatedByDelegateeUserId

protected List<TorqueDynamicUserDelegates> getTorqueDynamicUserDelegatessRelatedByDelegatorUserIdJoinTorqueDynamicUserRelatedByDelegateeUserId(org.apache.torque.criteria.Criteria criteria,
                                                                                                                                               Connection con)
                                                                                                                                        throws org.apache.torque.TorqueException

Forward reference to generated code Get a list of delegatee association objects, pre-populated with their TorqueDynamicUserDelegates objects.

Parameters:

criteria - Criteria to define the selection of records

con - a database connection

Returns:

a list of User/Delegator relations

Throws:

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

addGroup

public void addGroup(Group group)

Description copied from interface: BasicUser

Add the group to the list of groups

Specified by:

addGroup in interface BasicUser

Parameters:

group - the group to add

getGroups

public GroupSet getGroups()

Description copied from interface: BasicUser

Get the groups this user is part of

Specified by:

getGroups in interface BasicUser

Returns:

a set of groups

getGroupsAsSet

public <T extends Group> Set<T> getGroupsAsSet()

Description copied from interface: BasicUser

Get the groups this user is part of as a Set

Specified by:

getGroupsAsSet in interface BasicUser

Returns:

a set of groups

removeGroup

public void removeGroup(Group group)

Description copied from interface: BasicUser

Remove the group from the list of groups

Specified by:

removeGroup in interface BasicUser

Parameters:

group - the group to remove

setGroups

public void setGroups(GroupSet groups)

Description copied from interface: BasicUser

Set the groups this user is part of

Specified by:

setGroups in interface BasicUser

Parameters:

groups - the set of groups

setGroupsAsSet

public <T extends Group> void setGroupsAsSet(Set<T> groups)

Description copied from interface: BasicUser

Set the groups this user is part of as a Set

Specified by:

setGroupsAsSet in interface BasicUser

Parameters:

groups - the set of groups

getDelegatees

public <T extends User> Set<T> getDelegatees()

Description copied from interface: DynamicUser

Get the set of delegatees for this user

Specified by:

getDelegatees in interface DynamicUser

Returns:

Returns the delegatees.

getDelegators

public <T extends User> Set<T> getDelegators()

Description copied from interface: DynamicUser

Get the set of delegators for this user

Specified by:

getDelegators in interface DynamicUser

Returns:

Returns the delegators.

setDelegatees

public <T extends User> void setDelegatees(Set<T> delegatees)

Description copied from interface: DynamicUser

Set the delegatees for this user

Specified by:

setDelegatees in interface DynamicUser

Parameters:

delegatees - The delegatees to set.

setDelegators

public <T extends User> void setDelegators(Set<T> delegates)

Description copied from interface: DynamicUser

Set the delegators for this user

Specified by:

setDelegators in interface DynamicUser

Parameters:

delegates - The delegators to set.

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

See Also:

TorqueAbstractSecurityEntity.retrieveAttachedObjects(Connection, Boolean)

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

See Also:

TorqueAbstractSecurityEntity.update(java.sql.Connection)

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

See Also:

TorqueAbstractSecurityEntity.delete()