Package org.cyclos.services.access

Interface InternalAuthService

All Superinterfaces:

Service

All Known Subinterfaces:

InternalAuthServiceLocal

All Known Implementing Classes:

InternalAuthServiceImpl, InternalAuthServiceSecurity

public interface InternalAuthService
extends Service

Service used for login / get current authentication on REST

Method Summary

Modifier and Type	Method	Description
AuthVO	getCurrentAuth()	Returns the authentication information for the currently authenticated user
SessionPropertiesVO	getSessionProperties()	Returns the current session properties.
AuthVO	login(InternalLoginDTO loginParams)	Creates a session for the currently authenticated user, returning the auth.
AuthVO	loginUser(@NotNull UserLoginDTO params)	Creates a session for the given user, returning the auth
void	setSessionProperties(@NotNull SetSessionPropertiesDTO properties)	Sets the current session properties.

Method Detail

getCurrentAuth

AuthVO getCurrentAuth()
               throws FrameworkException

Returns the authentication information for the currently authenticated user

Throws:

FrameworkException

getSessionProperties

SessionPropertiesVO getSessionProperties()
                                  throws FrameworkException

Returns the current session properties.

Returns:

null if not logged in with a session.

Throws:

FrameworkException

login

AuthVO login(InternalLoginDTO loginParams)
      throws FrameworkException,
             LoginException,
             RemoteAddressBlockedException

Creates a session for the currently authenticated user, returning the auth. If a device confirmation id is given and can be validated correctly then the session will be marked as trusted meaning no confirmation password will be required. Otherwise, the session (silently) won't be marked as trusted and the confirmation password will be required according to the channel configuration.

Parameters:

loginParams - TODO

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

loginUser

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

Creates a session for the given user, returning the auth

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

setSessionProperties

void setSessionProperties(@NotNull
                          @NotNull SetSessionPropertiesDTO properties)
                   throws FrameworkException

Sets the current session properties.

Throws:

FrameworkException