Package org.cyclos.impl.access

Class SessionHandlerImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractGlobalServerComponent

org.cyclos.impl.BaseGlobalHandlerImpl

org.cyclos.impl.access.SessionHandlerImpl

All Implemented Interfaces:

SessionHandler, ApplicationInitializationListener

@Component
public class SessionHandlerImpl
extends BaseGlobalHandlerImpl
implements SessionHandler, ApplicationInitializationListener

Implementation for SessionHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionHandlerImpl.SessionDescriptor

Nested classes/interfaces inherited from interface org.cyclos.impl.access.SessionHandler

SessionHandler.CreateSessionParameters, SessionHandler.UserCheckResult

Field Summary

Fields inherited from class org.cyclos.impl.AbstractGlobalServerComponent

rawEntityManagerHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.ApplicationInitializationListener

MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

Fields inherited from interface org.cyclos.impl.access.SessionHandler

ATTR_CHANNEL, ATTR_PRINCIPAL, ATTR_QUERY, ATTR_REMOTE_ADDRESS, ATTR_SESSION_PROPERTIES, ATTR_SESSION_TIMEOUT, ATTR_SESSION_TOKEN, ATTR_TRUSTED, ATTR_USER

Constructor Summary

Constructors

Constructor	Description
SessionHandlerImpl()

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 token)	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
void	initialize()
boolean	invalidate(String remoteAddress, String token)	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.
void	onApplicationInitialization()	Invoked when the application service is initialized
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 newProperties)	Updates the properties of the given session
void	updateTimeout(String token, TimeInterval interval)	Updates the expiration time of the session with the given token

Methods inherited from class org.cyclos.impl.AbstractGlobalServerComponent

getBaseEntityManagerHandler, getEntityManager

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.impl.ApplicationInitializationListener

applicationInitializationPriority, getInitializationId

Constructor Detail

SessionHandlerImpl

public SessionHandlerImpl()

Method Detail

checkAccessClientAccess

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

Description copied from interface: SessionHandler

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

Specified by:

checkAccessClientAccess in interface SessionHandler

checkOidcAccessToken

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

Description copied from interface: SessionHandler

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

Specified by:

checkOidcAccessToken in interface SessionHandler

checkSecondaryPassword

public void checkSecondaryPassword(String password)

Description copied from interface: SessionHandler

Validate the pending secondary access password for the logged user.

Specified by:

checkSecondaryPassword in interface SessionHandler

checkUserAccess

public SessionHandler.UserCheckResult checkUserAccess(boolean forLogin,
                                                      boolean allowIfPasswordExpired,
                                                      Network network,
                                                      String channelName,
                                                      String remoteAddress,
                                                      UserLocatorVO locator,
                                                      String password,
                                                      Set<Group> allowedGroups)

Description copied from interface: SessionHandler

Checks the access for a user for a channel / network

Specified by:

checkUserAccess in interface SessionHandler

clearPinCreationToken

public void clearPinCreationToken(Session session)

Description copied from interface: SessionHandler

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

Specified by:

clearPinCreationToken in interface SessionHandler

create

public Session create(SessionHandler.CreateSessionParameters params)

Description copied from interface: SessionHandler

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

Specified by:

create in interface SessionHandler

See Also:

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

getIfValid

public Session getIfValid(String remoteAddress,
                          String token)

Description copied from interface: SessionHandler

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

Specified by:

getIfValid in interface SessionHandler

getPinCreationToken

public String getPinCreationToken(Session session)

Description copied from interface: SessionHandler

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.

Specified by:

getPinCreationToken in interface SessionHandler

getSessionTimeout

public TimeInterval getSessionTimeout(Session session)

Description copied from interface: SessionHandler

Returns the timeout for a given session

Specified by:

getSessionTimeout in interface SessionHandler

initialize

@PostConstruct
public void initialize()

invalidate

public boolean invalidate(String remoteAddress,
                          String token)

Description copied from interface: SessionHandler

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

Specified by:

invalidate in interface SessionHandler

login

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

Description copied from interface: SessionHandler

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.

Specified by:

login in interface SessionHandler

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

onApplicationInitialization

public void onApplicationInitialization()

Description copied from interface: ApplicationInitializationListener

Invoked when the application service is initialized

Specified by:

onApplicationInitialization in interface ApplicationInitializationListener

purgeExpired

public int purgeExpired()

Description copied from interface: SessionHandler

Purges all expired sessions. Should run outside a transaction.

Specified by:

purgeExpired in interface SessionHandler

remove

public int remove(Collection<String> tokens)

Description copied from interface: SessionHandler

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

Specified by:

remove in interface SessionHandler

remove

public boolean remove(Session session)

Description copied from interface: SessionHandler

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

Specified by:

remove in interface SessionHandler

replace

public String replace(Session session)

Description copied from interface: SessionHandler

Replaces an existing session token

Specified by:

replace in interface SessionHandler

setProperties

public void setProperties(Session session,
                          SessionProperties newProperties)

Description copied from interface: SessionHandler

Updates the properties of the given session

Specified by:

setProperties in interface SessionHandler

updateTimeout

public void updateTimeout(String token,
                          TimeInterval interval)

Description copied from interface: SessionHandler

Updates the expiration time of the session with the given token

Specified by:

updateTimeout in interface SessionHandler