Package org.cyclos.impl.access

Class LoginServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.access.LoginServiceImpl

All Implemented Interfaces:

LoginServiceLocal, LoginService, Service

@Service
public class LoginServiceImpl
extends BaseServiceImpl
implements LoginServiceLocal

Implementation 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
LoginServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	checkSecondaryPassword(String password)	Validate the secondary password for the logged user
Pair<Session,IdentityProviderNotLinkReason>	doLogin(TimeInterval customSessionTimeout, Long deviceConfirmationId, Long deviceId, String hmac, String identityProviderRequestId, String fcmDeviceToken)	Logs in the current user. If a device confirmation id, device id and HMAC are given then the following happen: For authenticated users: If valid a trusted session will be created which means higher payment limits could be applied, the confirmation password could be skipped (there is a setting in the channel configuration), etc.
Session	doLoginUser(UserLoginDTO params)	Logs in the given user
UserAuthVO	getAuthenticatedUser()	Returns the currently authenticated user
DateRange	getFirstAndLastLogin(BasicUser user)	Returns the first and last login of the given user, or null if never logged in before
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.
LoginData	getLoginData(Channel channel, Long deviceId, PinLocatorVO pinLocator)	Returns the data for user login according to the given channel. Optionally, a trusted device id and pin locator can be given to know if they already exist and are active.
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
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeAllLogs(BasicUser basicUser)	Removes all login history logs for the given user
String	replaceSession()	Replaces the current session token with another one.

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

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, toDate, toDateTime, validate

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

Constructor Detail

LoginServiceImpl

public LoginServiceImpl()

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

doLogin

public Pair<Session,IdentityProviderNotLinkReason> doLogin(TimeInterval customSessionTimeout,
                                                                 Long deviceConfirmationId,
                                                                 Long deviceId,
                                                                 String hmac,
                                                                 String identityProviderRequestId,
                                                                 String fcmDeviceToken)

Description copied from interface: LoginServiceLocal

Logs in the current user.
If a device confirmation id, device id and HMAC are given then the following happen:

• For authenticated users: If valid a trusted session will be created which means higher payment limits could be applied, the confirmation password could be skipped (there is a setting in the channel configuration), etc. Otherwise, the session (silently) won't be trusted and the confirmation password will be required according to the channel configuration.
• For guests: means a login with a trusted device is performing. For this case the session will be also trusted if the parameters are valid. Otherwise a LoginException will be thrown.

Returns both the session and a reason if the linking with the identity provider was skipped (e.g for being a global user in a network identity provider). A null reason means the linking was made.

Specified by:

doLogin in interface LoginServiceLocal

doLoginUser

public Session doLoginUser(UserLoginDTO params)

Description copied from interface: LoginServiceLocal

Logs in the given user

Specified by:

doLoginUser in interface LoginServiceLocal

getAuthenticatedUser

public UserAuthVO getAuthenticatedUser()
                                throws FrameworkException

Description copied from interface: LoginService

Returns the currently authenticated user

Specified by:

getAuthenticatedUser in interface LoginService

Throws:

FrameworkException

getFirstAndLastLogin

public DateRange getFirstAndLastLogin(BasicUser user)

Description copied from interface: LoginServiceLocal

Returns the first and last login of the given user, or null if never logged in before

Specified by:

getFirstAndLastLogin in interface LoginServiceLocal

getLoginData

public LoginData getLoginData(Channel channel,
                              Long deviceId,
                              PinLocatorVO pinLocator)

Description copied from interface: LoginServiceLocal

Returns the data for user login according to the given channel.
Optionally, a trusted device id and pin locator can be given to know if they already exist and are active.

Specified by:

getLoginData in interface LoginServiceLocal

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

removeAllLogs

public void removeAllLogs(BasicUser basicUser)

Description copied from interface: LoginServiceLocal

Removes all login history logs for the given user

Specified by:

removeAllLogs in interface LoginServiceLocal

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

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl