org.cyclos.impl.access

Interface SessionHandler

public interface SessionHandler

Handler for user sessions, containing methods to manage them

Author:

luis

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionHandler.UserCheckResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_CHANNEL Script attribute: the Channel a user is logging in
static java.lang.String	ATTR_QUERY Script attribute: the ConnectedUserQuery
static java.lang.String	ATTR_REMOTE_ADDRESS Script attribute: the remote address to which this session should be valid
static java.lang.String	ATTR_SESSION_TIMEOUT Script attribute: the TimeInterval that should be used as timeout
static java.lang.String	ATTR_SESSION_TOKEN Script attribute: the session token
static java.lang.String	ATTR_USER Script attribute: the BasicUser

Method Summary

Modifier and Type	Method and Description
AccessClient	checkAccessClientAccess(boolean forLogin, Network network, java.lang.String channelName, java.lang.String remoteAddress, java.lang.String accessClientToken) Checks the access for a user for a channel / network using the specified access client token.
void	checkSecondaryPassword(java.lang.String password) Validate the pending secondary access password for the logged user.
SessionHandler.UserCheckResult	checkUserAccess(boolean forLogin, boolean allowIfPasswordExpired, Network network, java.lang.String channelName, java.lang.String remoteAddress, UserLocatorVO locator, java.lang.String password) Checks the access for a user for a channel / network
Session	create(Channel channel, java.lang.String remoteAddress, TimeInterval customSessionTimeout, BasicUser user, AccessClient accessClient) Creates a new session for the given user using an access client.
Session	create(Channel channel, java.lang.String remoteAddress, TimeInterval customSessionTimeout, BasicUser user, PrincipalType principalType, java.lang.String principal) Creates a new session for the given user
Session	create(Channel channel, java.lang.String remoteAddress, TimeInterval customSessionTimeout, BasicUser user, Token token) Creates a new session for the given user using a token.
Session	getIfValid(java.lang.String remoteAddress, java.lang.String sessionToken) Returns an active session by remote address and session token.
TimeInterval	getSessionTimeout(Session session) Returns the timeout for a given session
boolean	invalidate(java.lang.String remoteAddress, java.lang.String sessionToken) Invalidates the session with the given token, under the given remote address, returning whether the sessions was actually invalidated.
Session	login(java.lang.String channelName, java.lang.String remoteAddress, TimeInterval customSessionTimeout, UserLocatorVO locator, java.lang.String password) Performs a login.
int	purgeExpired() Purges all expired sessions.
int	remove(java.util.Collection<java.lang.String> tokens) Removes (both from the shared map and from the database) sessions with the given tokens, returning the number of actually deleted sessions
java.lang.String	replace(Session session) Replaces an existing session token
void	updateTimeout(java.lang.String sessionToken, TimeInterval interval) Updates the expiration time of the session with the given token

Field Detail

ATTR_USER

static final java.lang.String ATTR_USER

Script attribute: the BasicUser

See Also:

Constant Field Values

ATTR_SESSION_TOKEN

static final java.lang.String ATTR_SESSION_TOKEN

Script attribute: the session token

See Also:

Constant Field Values

ATTR_CHANNEL

static final java.lang.String ATTR_CHANNEL

Script attribute: the Channel a user is logging in

See Also:

Constant Field Values

ATTR_SESSION_TIMEOUT

static final java.lang.String ATTR_SESSION_TIMEOUT

Script attribute: the TimeInterval that should be used as timeout

See Also:

Constant Field Values

ATTR_REMOTE_ADDRESS

static final java.lang.String ATTR_REMOTE_ADDRESS

Script attribute: the remote address to which this session should be valid

See Also:

Constant Field Values

ATTR_QUERY

static final java.lang.String ATTR_QUERY

Script attribute: the ConnectedUserQuery

See Also:

Constant Field Values

Method Detail

checkAccessClientAccess

AccessClient checkAccessClientAccess(boolean forLogin,
                                     Network network,
                                     java.lang.String channelName,
                                     java.lang.String remoteAddress,
                                     java.lang.String accessClientToken)

Checks the access for a user for a channel / network using the specified access client token.

checkSecondaryPassword

void checkSecondaryPassword(java.lang.String password)
                     throws FrameworkException

Validate the pending secondary access password for the logged user.

Throws:

FrameworkException

checkUserAccess

SessionHandler.UserCheckResult checkUserAccess(boolean forLogin,
                                               boolean allowIfPasswordExpired,
                                               Network network,
                                               java.lang.String channelName,
                                               java.lang.String remoteAddress,
                                               UserLocatorVO locator,
                                               java.lang.String password)

Checks the access for a user for a channel / network

create

Session create(Channel channel,
               java.lang.String remoteAddress,
               TimeInterval customSessionTimeout,
               BasicUser user,
               AccessClient accessClient)

Creates a new session for the given user using an access client.

create

Session create(Channel channel,
               java.lang.String remoteAddress,
               TimeInterval customSessionTimeout,
               BasicUser user,
               PrincipalType principalType,
               java.lang.String principal)

Creates a new session for the given user

create

Session create(Channel channel,
               java.lang.String remoteAddress,
               TimeInterval customSessionTimeout,
               BasicUser user,
               Token token)

Creates a new session for the given user using a token.

getIfValid

Session getIfValid(java.lang.String remoteAddress,
                   java.lang.String sessionToken)

Returns an active session by remote address and session token. If the session has expired or doesn't match the remote address, returns null

getSessionTimeout

TimeInterval getSessionTimeout(Session session)

Returns the timeout for a given session

invalidate

boolean invalidate(java.lang.String remoteAddress,
                   java.lang.String sessionToken)

Invalidates the session with the given token, under the given remote address, returning whether the sessions was actually invalidated.

login

Session login(java.lang.String channelName,
              java.lang.String remoteAddress,
              TimeInterval customSessionTimeout,
              UserLocatorVO locator,
              java.lang.String password)
       throws FrameworkException,
              LoginException,
              RemoteAddressBlockedException

Performs a login. Checks the remote address blocking by exceeding invalid username attempts, and creates a session

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

purgeExpired

int purgeExpired()

Purges all expired sessions. Should run outside a transaction.

remove

int remove(java.util.Collection<java.lang.String> tokens)

Removes (both from the shared map and from the database) sessions with the given tokens, returning the number of actually deleted sessions

replace

java.lang.String replace(Session session)

Replaces an existing session token

updateTimeout

void updateTimeout(java.lang.String sessionToken,
                   TimeInterval interval)

Updates the expiration time of the session with the given token