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

Class TorqueTurbineUserManagerImpl

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.AbstractUserManager

org.apache.fulcrum.security.torque.TorqueAbstractUserManager

org.apache.fulcrum.security.torque.peer.managers.PeerUserManager

org.apache.fulcrum.security.torque.turbine.TorqueTurbineUserManagerImpl

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, TurbineUserManager, PeerManagable, UserManager

public class TorqueTurbineUserManagerImpl
extends PeerUserManager
implements TurbineUserManager

This implementation persists to a database via Torque.

Version:

$Id$

Author:

Thomas Vandahl

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.fulcrum.security.spi.AbstractManager

manager

Fields inherited from interface org.apache.fulcrum.security.UserManager

ROLE

Constructor Summary

Constructors

Constructor	Description
TorqueTurbineUserManagerImpl()

Method Summary

Modifier and Type	Method	Description
protected <T extends User> List<T>	doSelectAllUsers(Connection con)	Get all specialized Users
protected <T extends User> T	doSelectById(Integer id, Connection con)	Get a specialized User by id
protected <T extends User> T	doSelectByName(String name, Connection con)	Get a specialized User by name
<T extends User> UserSet<T>	getAllUsers()	Retrieves all users with attached related objects (user group role relationships) defined in the system.
<T extends User> T	getAnonymousUser()	Default implementation.
<T extends User> T	getUser(String userName)	Retrieve a user from persistent storage using username as the key.
<T extends User> T	getUserById(Object id)	Retrieve a User object with specified id and all attached objects (user group role relationships).
boolean	isAnonymousUser(User u)	Default implementation.

Methods inherited from class org.apache.fulcrum.security.torque.peer.managers.PeerUserManager

configure, getColumnName, getColumnName4UserGroupRole, getCustomPeer, getPeerClassName, getPeerInstance, getPeerManager, getUserGroupRolePeerClassName, getUserGroupRolePeerInstance, setColumnName, setColumnName4UserGroupRole, setCustomPeer, setPeerClassName, setUserGroupRolePeerClassName

Methods inherited from class org.apache.fulcrum.security.torque.TorqueAbstractUserManager

checkExists, persistNewUser, removeUser, saveUser

Methods inherited from class org.apache.fulcrum.security.spi.AbstractUserManager

addUser, authenticate, changePassword, checkExists, forcePassword, getACL, getACLFactory, getUser, getUserInstance, getUserInstance

Methods inherited from class org.apache.fulcrum.security.spi.AbstractEntityManager

getClassName, setClassName

Methods inherited from class org.apache.fulcrum.security.spi.AbstractManager

dispose, getGroupManager, getPermissionManager, getRoleManager, getServiceManager, getUserManager, release, resolve, service

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.fulcrum.security.UserManager

addUser, authenticate, changePassword, checkExists, checkExists, forcePassword, getACL, getUser, getUserInstance, getUserInstance, removeUser, saveUser

Constructor Detail

TorqueTurbineUserManagerImpl

public TorqueTurbineUserManagerImpl()

Method Detail

getAnonymousUser

public <T extends User> T getAnonymousUser()
                                    throws UnknownEntityException

Default implementation.

Specified by:

getAnonymousUser in interface TurbineUserManager

Returns:

An anonymous Turbine User.

Throws:

UnknownEntityException - if the anonymous User object couldn't be constructed.

isAnonymousUser

public boolean isAnonymousUser(User u)

Default implementation.

Specified by:

isAnonymousUser in interface TurbineUserManager

Parameters:

u - A user object

Returns:

True if this is an anonymous user

doSelectAllUsers

protected <T extends User> List<T> doSelectAllUsers(Connection con)
                                             throws org.apache.torque.TorqueException

Description copied from class: TorqueAbstractUserManager

Get all specialized Users

Specified by:

doSelectAllUsers in class TorqueAbstractUserManager

Parameters:

con - a database connection

Returns:

a List of User instances

Throws:

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

See Also:

TorqueAbstractUserManager.doSelectAllUsers(java.sql.Connection)

doSelectById

protected <T extends User> T doSelectById(Integer id,
                                          Connection con)
                                   throws org.apache.torque.NoRowsException,
                                          org.apache.torque.TooManyRowsException,
                                          org.apache.torque.TorqueException

Description copied from class: TorqueAbstractUserManager

Get a specialized User by id

Specified by:

doSelectById in class TorqueAbstractUserManager

Parameters:

id - the id of the group

con - a database connection

Returns:

a User instance

Throws:

org.apache.torque.NoRowsException - if no such group exists

org.apache.torque.TooManyRowsException - if multiple groups with the given id exist

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

See Also:

TorqueAbstractUserManager.doSelectById(java.lang.Integer, java.sql.Connection)

doSelectByName

protected <T extends User> T doSelectByName(String name,
                                            Connection con)
                                     throws org.apache.torque.NoRowsException,
                                            org.apache.torque.TooManyRowsException,
                                            org.apache.torque.TorqueException

Description copied from class: TorqueAbstractUserManager

Get a specialized User by name

Specified by:

doSelectByName in class TorqueAbstractUserManager

Parameters:

name - the name of the group

con - a database connection

Returns:

a User instance

Throws:

org.apache.torque.NoRowsException - if no such group exists

org.apache.torque.TooManyRowsException - if multiple groups with the given name exist

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

See Also:

TorqueAbstractUserManager.doSelectByName(java.lang.String, java.sql.Connection)

getUser

public <T extends User> T getUser(String userName)
                           throws UnknownEntityException,
                                  DataBackendException

Retrieve a user from persistent storage using username as the key. Also retrieves all attached objects (user group role relationships).

Specified by:

getUser in interface UserManager

Overrides:

getUser in class TorqueAbstractUserManager

Type Parameters:

T - User

Parameters:

userName - the name of the user.

Returns:

an User object.

Throws:

UnknownEntityException - if the user's account does not exist in the database.

DataBackendException - if there is a problem accessing the storage.

getAllUsers

public <T extends User> UserSet<T> getAllUsers()
                                        throws DataBackendException

Retrieves all users with attached related objects (user group role relationships) defined in the system.

Specified by:

getAllUsers in interface UserManager

Overrides:

getAllUsers in class TorqueAbstractUserManager

Type Parameters:

T - User type

Returns:

the names of all users defined in the system.

Throws:

DataBackendException - if there was an error accessing the data backend.

getUserById

public <T extends User> T getUserById(Object id)
                               throws DataBackendException,
                                      UnknownEntityException

Retrieve a User object with specified id and all attached objects (user group role relationships).

Specified by:

getUserById in interface UserManager

Overrides:

getUserById in class TorqueAbstractUserManager

Type Parameters:

T - User

Parameters:

id - the id of the User.

Returns:

an object representing the User with specified id.

Throws:

DataBackendException - if there was an error accessing the data backend.

UnknownEntityException - if the user does not exist.