Package org.cyclos.security.access

Class LoginServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.access.LoginServiceSecurity

All Implemented Interfaces:

LoginService, Service

@Security
public class LoginServiceSecurity
extends BaseServiceSecurity
implements LoginService

Security layer for LoginService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

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

Constructor Summary

Constructors

Constructor	Description
LoginServiceSecurity()

Method Summary

Modifier and Type	Method	Description
void	checkSecondaryPassword(String password)	Validate the secondary password for the logged user
UserAuthVO	getAuthenticatedUser()	Returns the currently authenticated user
LoginData	getLoginData(String channelName, Long deviceId, PinLocatorVO pinLocator)	Returns the data for user login according to the given channel name and based in the current session configuration.
PasswordInputDTO	getSecondaryPasswordInput()	Returns the input for the secondary password for the logged user.
UserLoginResult	login(LoginDTO params)	Creates a session for the currently authenticated user and optionally sets a timeout for it.
UserLoginDetailedResult	loginUser(UserLoginDTO params)	Creates a session for a user, indicating a remote address (from the client connection) a channel and optionally a timeout. Must be called by administrators with permissions to login other users, and is used when there is a system which relays logins to Cyclos.
void	logout()	Invalidates the current user session, if the current request was authenticated with a session
boolean	logoutUser(String token)	Removes the session with the given token, returning whether the sessions was actually removed
String	replaceSession()	Replaces the current session token with another one.
protected EntityCheck<?>	resolveEntityCheck()	Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, 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

Constructor Detail

LoginServiceSecurity

public LoginServiceSecurity()

Method Detail

checkSecondaryPassword

public void checkSecondaryPassword(String password)

Description copied from interface: LoginService

Validate the secondary password for the logged user

Specified by:

checkSecondaryPassword in interface LoginService

getAuthenticatedUser

public UserAuthVO getAuthenticatedUser()
                                throws FrameworkException

Description copied from interface: LoginService

Returns the currently authenticated user

Specified by:

getAuthenticatedUser in interface LoginService

Throws:

FrameworkException

getLoginData

public LoginData getLoginData(String channelName,
                              Long deviceId,
                              PinLocatorVO pinLocator)

Description copied from interface: LoginService

Returns the data for user login according to the given channel name and based in the current session configuration.

Specified by:

getLoginData in interface LoginService

deviceId - (Optional) A trusted device id can be given to know if it is operative, if so then a pending device confirmation will be created (in a new read-write transaction) and its id returned in the result data. Otherwise no confirmation will be created.

pinLocator - (Optional) A device pin locator can be given to know it it is operative

getSecondaryPasswordInput

public PasswordInputDTO getSecondaryPasswordInput()

Description copied from interface: LoginService

Returns the input for the secondary password for the logged user.

Specified by:

getSecondaryPasswordInput in interface LoginService

login

public UserLoginResult login(LoginDTO params)
                      throws FrameworkException,
                             LoginException,
                             RemoteAddressBlockedException

Description copied from interface: LoginService

Creates a session for the currently authenticated user and optionally sets a timeout for it. Also, if an identity provider state id is given, and such state exists, the user that performed the login will be linked to that provider

Specified by:

login in interface LoginService

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

loginUser

public UserLoginDetailedResult loginUser(UserLoginDTO params)
                                  throws FrameworkException,
                                         LoginException,
                                         RemoteAddressBlockedException

Description copied from interface: LoginService

Creates a session for a user, indicating a remote address (from the client connection) a channel and optionally a timeout.
Must be called by administrators with permissions to login other users, and is used when there is a system which relays logins to Cyclos.

Specified by:

loginUser in interface LoginService

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

logout

public void logout()
            throws FrameworkException

Description copied from interface: LoginService

Invalidates the current user session, if the current request was authenticated with a session

Specified by:

logout in interface LoginService

Throws:

FrameworkException

logoutUser

public boolean logoutUser(String token)
                   throws FrameworkException

Description copied from interface: LoginService

Removes the session with the given token, returning whether the sessions was actually removed

Specified by:

logoutUser in interface LoginService

Throws:

FrameworkException

replaceSession

public String replaceSession()
                      throws FrameworkException

Description copied from interface: LoginService

Replaces the current session token with another one. Only works if the current authentication is done via a session. The current session will have a new token generated, and that token is returned. If not connected as a session, will return null.

Specified by:

replaceSession in interface LoginService

Throws:

FrameworkException

resolveEntityCheck

protected EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity