org.cyclos.services.access

Interface LoginService

All Superinterfaces:

Service

public interface LoginService
extends Service

Service used to provide login for users via web services

Author:

luis

Method Summary

Modifier and Type	Method and Description
void	checkSecondaryPassword(java.lang.String password) Validate the secondary password for the logged user
LoginData	getLoginData(java.lang.String channelName) 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(TimeIntervalDTO sessionTimeout) Creates a session for the currently authenticated user and optionally sets a timeout for it.
InitializationData	loginAndGetInitializationData(TimeIntervalDTO sessionTimeout) Same as login(TimeIntervalDTO) but returning the InitializationData.
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(java.lang.String token) Removes the session with the given token, returning whether the sessions was actually removed
java.lang.String	replaceSession() Replaces the current session token with another one.

Method Detail

checkSecondaryPassword

void checkSecondaryPassword(java.lang.String password)
                     throws FrameworkException

Validate the secondary password for the logged user

Throws:

FrameworkException

getLoginData

LoginData getLoginData(@NotNull
                       java.lang.String channelName)

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

getSecondaryPasswordInput

PasswordInputDTO getSecondaryPasswordInput()

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

login

UserLoginResult login(TimeIntervalDTO sessionTimeout)
               throws FrameworkException,
                      LoginException,
                      RemoteAddressBlockedException

Creates a session for the currently authenticated user and optionally sets a timeout for it.

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

loginAndGetInitializationData

InitializationData loginAndGetInitializationData(TimeIntervalDTO sessionTimeout)
                                          throws FrameworkException

Same as login(TimeIntervalDTO) but returning the InitializationData.

Throws:

FrameworkException

loginUser

UserLoginDetailedResult loginUser(@NotNull
                                  UserLoginDTO params)
                           throws FrameworkException,
                                  LoginException,
                                  RemoteAddressBlockedException

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.

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

logout

void logout()
     throws FrameworkException

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

Throws:

FrameworkException

logoutUser

boolean logoutUser(@NotNull
                   java.lang.String token)
            throws FrameworkException

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

Throws:

FrameworkException

replaceSession

java.lang.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