Package org.cyclos.services.access

Interface LoginService

All Superinterfaces:

Service

All Known Subinterfaces:

LoginServiceLocal

public interface LoginService
extends Service

Service used to provide login for users via web services

Method Summary

Modifier and Type	Method	Description
void	confirmLogin(String password)	Validates the login confirmation for the logged user
UserAuthVO	getAuthenticatedUser()	Returns the currently authenticated user
CredentialInputDTO	getLoginConfirmationCredentialInput()	Returns data for entering the login confirmation credential for the current session, if any.
LoginData	getLoginData(@NotNull 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.
String	replaceSession()	Replaces the current session token with another one.

Method Detail

confirmLogin

void confirmLogin(String password)
           throws FrameworkException

Validates the login confirmation for the logged user

Throws:

FrameworkException

getAuthenticatedUser

UserAuthVO getAuthenticatedUser()
                         throws FrameworkException

Returns the currently authenticated user

Throws:

FrameworkException

getLoginConfirmationCredentialInput

CredentialInputDTO getLoginConfirmationCredentialInput()
                                                throws FrameworkException

Returns data for entering the login confirmation credential for the current session, if any.

Throws:

FrameworkException

getLoginData

LoginData getLoginData(@NotNull
                       @NotNull String channelName,
                       Long deviceId,
                       PinLocatorVO pinLocator)
                throws FrameworkException

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

Parameters:

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

Throws:

FrameworkException

replaceSession

String replaceSession()
               throws FrameworkException

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.

Throws:

FrameworkException