service.tut.pori.users

Class UserDAO

java.lang.Object

core.tut.pori.dao.SQLDAO

service.tut.pori.users.UserDAO

public class UserDAO
extends SQLDAO

DAO for retrieving user details, and for creating new users. This class can also be used to modify existing users as well as list and modify user's external account connections.

Constructor Summary

Constructors

Constructor and Description
UserDAO()

Method Summary

Modifier and Type	Method and Description
boolean	addUser(UserIdentity userId) On success, the passed userId will have the generated userId value set.
boolean	deleteExternalAccountConnection(ExternalAccountConnection.UserServiceType userServiceType, UserIdentity userId)
ExternalAccountConnection	getExternalAccountConnection(UserIdentity userId, ExternalAccountConnection.UserServiceType serviceType)
ExternalAccountConnectionList	getExternalAccountConnections(java.util.EnumSet<ExternalAccountConnection.UserServiceType> serviceTypes, UserIdentity userId)
UserIdentity	getUser(java.lang.Long userId)
UserIdentity	getUser(java.lang.String username)
UserIdentity	getUserId(ExternalAccountConnection connection)
UserIdentityList	getUsers(long[] userIds) Note: this will NOT resolve user roles
void	insertExternalAccountConnection(ExternalAccountConnection connection, UserIdentity userId)
boolean	removeUser(UserIdentity userId) Remove the user and all external id connections.

Methods inherited from class core.tut.pori.dao.SQLDAO

getTransactionTemplate, setDataSource, setTnxManager

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDAO

public UserDAO()

Method Detail

getUser

public UserIdentity getUser(java.lang.String username)

Parameters:

username -

Returns:

the user or null if not found

getUser

public UserIdentity getUser(java.lang.Long userId)

Parameters:

userId -

Returns:

the user or null if not found

getUsers

public UserIdentityList getUsers(long[] userIds)

Note: this will NOT resolve user roles

Parameters:

userIds -

Returns:

list of matching user identities or null if none

getUserId

public UserIdentity getUserId(ExternalAccountConnection connection)

Parameters:

connection -

Returns:

UserIdentity with the id value set or null if none is found

insertExternalAccountConnection

public void insertExternalAccountConnection(ExternalAccountConnection connection,
                                            UserIdentity userId)
                                     throws java.lang.IllegalArgumentException

Parameters:

connection -

userId -

Throws:

java.lang.IllegalArgumentException

removeUser

public boolean removeUser(UserIdentity userId)

Remove the user and all external id connections.

Parameters:

userId -

Returns:

true if user of the given id was removed

addUser

public boolean addUser(UserIdentity userId)
                throws java.lang.IllegalArgumentException

On success, the passed userId will have the generated userId value set.

Parameters:

userId - must have username, password and role set

Returns:

true on success, generally means invalid username, as generic database errors will throw an exception

Throws:

java.lang.IllegalArgumentException - on bad userId

getExternalAccountConnections

public ExternalAccountConnectionList getExternalAccountConnections(java.util.EnumSet<ExternalAccountConnection.UserServiceType> serviceTypes,
                                                                   UserIdentity userId)

Parameters:

serviceTypes - optional service type filter

userId -

Returns:

list of connections or null if none found

getExternalAccountConnection

public ExternalAccountConnection getExternalAccountConnection(UserIdentity userId,
                                                              ExternalAccountConnection.UserServiceType serviceType)

Parameters:

userId -

serviceType -

Returns:

the matching external account connection or null if none found

deleteExternalAccountConnection

public boolean deleteExternalAccountConnection(ExternalAccountConnection.UserServiceType userServiceType,
                                               UserIdentity userId)

Parameters:

userServiceType -

userId -

Returns:

true if connection was removed. Note that false means that the connection did not exist, on database error an appropriate exception will be thrown.