Package de.hybris.platform.servicelayer.security.auth

Interface AuthenticationService

All Known Implementing Classes:

DefaultAuthenticationService

public interface AuthenticationService

Service to authenticate a hybris user by login and password.

Spring Bean ID:

authenticationService

Method Summary

Modifier and Type	Method	Description
UserModel	checkCredentials(java.lang.String login, java.lang.String password)	check credentials.
UserModel	login(java.lang.String login, java.lang.String password)	login the user identified with login and password.
void	logout()	log out the current user.

Method Detail

checkCredentials

UserModel checkCredentials(java.lang.String login,
                           java.lang.String password)
                    throws InvalidCredentialsException

check credentials. this method does not set the user on the current session.

Parameters:

login - the login

password - the password

Returns:

the UserModel

Throws:

InvalidCredentialsException - if username/login does not match

login

UserModel login(java.lang.String login,
                java.lang.String password)
         throws InvalidCredentialsException

login the user identified with login and password. login means the credentials are checked and the user is being set as current user on the session (see UserService.setCurrentUser(UserModel)) Implementation note: The default implementation checks against the Jalo user UID and the password.

Parameters:

login - the login

password - the password

Returns:

the same usermodel that is also set as current user in the session

Throws:

InvalidCredentialsException - if username/login does not match

logout

void logout()

log out the current user. this closes the underlaying session