de.hybris.platform.cockpit.services.login

Interface LoginService

All Known Implementing Classes:

LoginServiceImpl, LoginServiceImpl, LoginServiceImpl, LoginServiceImpl, LoginServiceImpl

public interface LoginService

The interface LoginService exposes functions to perform logging in and out in cockpits.

Method Summary

Modifier and Type	Method and Description
void	deleteLoginTokenCookie(HttpServletRequest request, HttpServletResponse response) Delete login token cookie.
UserSessionSettings	doLogin(String login, String password, LanguageModel requestedLanguage) Do login.
void	doLogout(HttpServletRequest request, HttpServletResponse response) Do logout.
UserSessionSettings	getCurrentSessionSettings() Gets the current session settings.
String	getDefaultUsername() Gets the default username.
String	getDefaultUserPassword() Gets the default user password.
Locale	getLocale(LanguageModel lang) Gets the locale.
void	setSessionLanguage(LanguageModel lang) Sets the session language.
void	storeLoginTokenCookie(String user, String language, String passwd, HttpServletResponse response) Store login token cookie.
UserSessionSettings	verifyLoginToken(HttpServletRequest request) Verify login token.

Method Detail

setSessionLanguage

void setSessionLanguage(LanguageModel lang)

Sets the session language.

Parameters:

lang - the new session language

getCurrentSessionSettings

UserSessionSettings getCurrentSessionSettings()

Gets the current session settings.

Returns:

the current session settings

doLogin

UserSessionSettings doLogin(String login,
                            String password,
                            LanguageModel requestedLanguage)
                     throws SecurityException

Do login.

Parameters:

login - the login

password - the password

requestedLanguage - the requested language

Returns:

the user session settings

Throws:

SecurityException - the security exception

doLogout

void doLogout(HttpServletRequest request,
              HttpServletResponse response)

Do logout.

Parameters:

request - the request

response - the response

verifyLoginToken

UserSessionSettings verifyLoginToken(HttpServletRequest request)

Verify login token.

Parameters:

request - the request

Returns:

the user session settings

storeLoginTokenCookie

void storeLoginTokenCookie(String user,
                           String language,
                           String passwd,
                           HttpServletResponse response)

Store login token cookie.

Parameters:

user - the user

language - the language

passwd - the passwd

response - the response

deleteLoginTokenCookie

void deleteLoginTokenCookie(HttpServletRequest request,
                            HttpServletResponse response)

Delete login token cookie.

Parameters:

request - the request

response - the response

getLocale

Locale getLocale(LanguageModel lang)

Gets the locale.

Parameters:

lang - the lang

Returns:

the locale

getDefaultUsername

String getDefaultUsername()

Gets the default username.

Returns:

the default username

getDefaultUserPassword

String getDefaultUserPassword()

Gets the default user password.

Returns:

the default user password