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

Methods

Modifier and Type	Method and Description
UserLoginResult	login() Creates a session for the currently authenticated user
UserLoginResult	loginUser(UserLoginDTO params) Creates a session for an user, indicating a remote address (from the client connection) and a channel.
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

Method Detail

login

UserLoginResult login()
                      throws FrameworkException,
                             LoginException,
                             RemoteAddressBlockedException

Creates a session for the currently authenticated user

Throws:

FrameworkException

LoginException

RemoteAddressBlockedException

loginUser

UserLoginResult loginUser(UserLoginDTO params)
                          throws FrameworkException,
                                 LoginException,
                                 RemoteAddressBlockedException

Creates a session for an user, indicating a remote address (from the client connection) and a channel. 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(java.lang.String token)
                   throws FrameworkException

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

Throws:

FrameworkException