org.jbei.ice.lib.account

Class UserSessions

java.lang.Object

org.jbei.ice.lib.account.UserSessions

public class UserSessions
extends Object

Creates and maintains the web application sessions for users who have successfully authenticated

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
UserSessions()

Method Summary

Modifier and Type	Method and Description
static String	createNewSessionForUser(String userId) Creates a new session id for the specified user stores and returns it
static String	createSessionForUser(String userId, String sessionId) Uses the session id passed in the parameter and sets it as the session id for the user as long as it meets a specified criteria (currently must be at least 5 xters long)
static AccountTransfer	getUserAccount(String requestingUser, String token) Retrieves the account object associated with the session identifier.
static String	getUserIdBySession(String sessionId)
static void	invalidateSession(String userId) Invalidates the session id for the specified user by removing the stored session id
protected static void	putSession(String userId, String sessionId)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSessions

public UserSessions()

Method Detail

getUserIdBySession

public static String getUserIdBySession(String sessionId)

createNewSessionForUser

public static String createNewSessionForUser(String userId)

Creates a new session id for the specified user stores and returns it

Parameters:

userId - unique user identifier

Returns:

newly created session id

putSession

protected static void putSession(String userId,
                                 String sessionId)

createSessionForUser

public static String createSessionForUser(String userId,
                                          String sessionId)

Uses the session id passed in the parameter and sets it as the session id for the user as long as it meets a specified criteria (currently must be at least 5 xters long)

Parameters:

userId - unique user identifier

sessionId - optional session id to set for that user

Returns:

session id set for specified user. It will be the same as that passed in the parameter if it meets the criteria

invalidateSession

public static void invalidateSession(String userId)

Invalidates the session id for the specified user by removing the stored session id

Parameters:

userId - unique user id

getUserAccount

public static AccountTransfer getUserAccount(String requestingUser,
                                             String token)

Retrieves the account object associated with the session identifier. If the requesting user is not the same as the user associated with the session, then the requesting user is required to have administrative privileges on their account

Parameters:

requestingUser - unique identifier for user making request

token - unique session identifier

Returns:

account associated with the session token/identifier or null if no account is located

Throws:

PermissionException - if the user Id associated with the session token is not the same as the requesting user but the requesting user's account does not have administrative privileges