Package org.cyclos.impl.access

Interface SessionHandler

All Known Implementing Classes:

SessionHandlerImpl

public interface SessionHandler

Handler for user sessions, containing methods to manage them

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SessionHandler.CreateSessionParameters
static class	SessionHandler.UserCheckResult

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CHANNEL	Script attribute: the Channel a user is logging in
static String	ATTR_PRINCIPAL	Script attribute: the UserPrincipal
static String	ATTR_QUERY	Script attribute: the ConnectedUserQuery
static String	ATTR_REMOTE_ADDRESS	Script attribute: the remote address to which this session should be valid
static String	ATTR_SESSION_PROPERTIES	Script attribute: the updated session properties
static String	ATTR_SESSION_TIMEOUT	Script attribute: the TimeInterval that should be used as timeout
static String	ATTR_SESSION_TOKEN	Script attribute: the session token
static String	ATTR_TRUSTED	Script attribute: whether the login is performed from a valid trusted device or not
static String	ATTR_USER	Script attribute: the BasicUser

Method Summary

Modifier and Type	Method	Description
AccessClient	checkAccessClientAccess(boolean forLogin, Network network, String channelName, String remoteAddress, String accessClientToken)	Checks the access for a user for a channel / network using the specified access client token.
OidcAccessToken	checkOidcAccessToken(Network network, String remoteAddress, String accessToken)	Checks the access for a user for a network using the specified OAuth2 / OpenID Connect access token.
void	checkSecondaryPassword(String password)	Validate the pending secondary access password for the logged user.
SessionHandler.UserCheckResult	checkUserAccess(boolean forLogin, boolean allowIfPasswordExpired, Network network, String channelName, String remoteAddress, UserLocatorVO locator, String password, Set<Group> allowedGroups)	Checks the access for a user for a channel / network
void	clearPinCreationToken(Session session)	Removes the PIN creation token for the given session, if any
Session	create(SessionHandler.CreateSessionParameters params)	Creates a new session according to the given session data and timeout. See the Javadoc for LoginServiceLocal#doLogin(TimeInterval, Long, Long, String, String).
Session	getIfValid(String remoteAddress, String sessionToken)	Returns an active session by remote address and session token.
String	getPinCreationToken(Session session)	Returns the token that can be used to create a device PIN without informing the current password / PIN.
TimeInterval	getSessionTimeout(Session session)	Returns the timeout for a given session
boolean	invalidate(String remoteAddress, String sessionToken)	Invalidates the session with the given token, under the given remote address, returning whether the sessions was actually invalidated.
Session	login(String channelName, String remoteAddress, TimeInterval customSessionTimeout, UserLocatorVO locator, String password, Set<Group> allowedGroups)	Performs a login.
int	purgeExpired()	Purges all expired sessions.
int	remove(Collection<String> tokens)	Removes (both from the shared map and from the database) sessions with the given tokens, returning the number of actually deleted sessions
boolean	remove(Session session)	Removes (both from the shared map and from the database) the given session, returning true if was actually removed
String	replace(Session session)	Replaces an existing session token
void	setProperties(Session session, SessionProperties properties)	Updates the properties of the given session
void	updateTimeout(String sessionToken, TimeInterval interval)	Updates the expiration time of the session with the given token

Field Detail

ATTR_USER

static final String ATTR_USER

Script attribute: the BasicUser

See Also:

Constant Field Values

ATTR_PRINCIPAL

static final String ATTR_PRINCIPAL

Script attribute: the UserPrincipal

See Also:

Constant Field Values

ATTR_TRUSTED

static final String ATTR_TRUSTED

Script attribute: whether the login is performed from a valid trusted device or not

See Also:

Constant Field Values

ATTR_SESSION_TOKEN

static final String ATTR_SESSION_TOKEN

Script attribute: the session token

See Also:

Constant Field Values

ATTR_SESSION_PROPERTIES

static final String ATTR_SESSION_PROPERTIES

Script attribute: the updated session properties

See Also:

Constant Field Values

ATTR_CHANNEL

static final String ATTR_CHANNEL

Script attribute: the Channel a user is logging in

See Also:

Constant Field Values

ATTR_SESSION_TIMEOUT

static final String ATTR_SESSION_TIMEOUT

Script attribute: the TimeInterval that should be used as timeout

See Also:

Constant Field Values

ATTR_REMOTE_ADDRESS

static final 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 String ATTR_QUERY

Script attribute: the ConnectedUserQuery

See Also:

Constant Field Values

Method Detail

checkAccessClientAccess

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

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

checkOidcAccessToken

OidcAccessToken checkOidcAccessToken(Network network,
                                     String remoteAddress,
                                     String accessToken)

Checks the access for a user for a network using the specified OAuth2 / OpenID Connect access token. The channel is always BuiltInChannel.OIDC.

checkSecondaryPassword

void checkSecondaryPassword(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,
                                               String channelName,
                                               String remoteAddress,
                                               UserLocatorVO locator,
                                               String password,
                                               Set<Group> allowedGroups)

Checks the access for a user for a channel / network

clearPinCreationToken

void clearPinCreationToken(Session session)

Removes the PIN creation token for the given session, if any

create

Session create(SessionHandler.CreateSessionParameters params)

Creates a new session according to the given session data and timeout.
See the Javadoc for LoginServiceLocal#doLogin(TimeInterval, Long, Long, String, String).

See Also:

LoginServiceLocal#doLogin(TimeInterval, Long, Long, String, String)

getIfValid

Session getIfValid(String remoteAddress,
                   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

getPinCreationToken

String getPinCreationToken(Session session)

Returns the token that can be used to create a device PIN without informing the current password / PIN. The token is valid for 6 hours since the session is created.

getSessionTimeout

TimeInterval getSessionTimeout(Session session)

Returns the timeout for a given session

invalidate

boolean invalidate(String remoteAddress,
                   String sessionToken)

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

login

Session login(String channelName,
              String remoteAddress,
              TimeInterval customSessionTimeout,
              UserLocatorVO locator,
              String password,
              Set<Group> allowedGroups)
       throws FrameworkException,
              LoginException,
              RemoteAddressBlockedException

Performs a login. Checks the remote address blocking by exceeding invalid username attempts, and creates a session. When allowedGroups is null, allows any group to login. Otherwise, retrict login to users of these groups.

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

purgeExpired

int purgeExpired()

Purges all expired sessions. Should run outside a transaction.

remove

int remove(Collection<String> tokens)

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

remove

boolean remove(Session session)

Removes (both from the shared map and from the database) the given session, returning true if was actually removed

replace

String replace(Session session)

Replaces an existing session token

setProperties

void setProperties(Session session,
                   SessionProperties properties)

Updates the properties of the given session

updateTimeout

void updateTimeout(String sessionToken,
                   TimeInterval interval)

Updates the expiration time of the session with the given token