com.haulmont.cuba.security.auth

Class AuthenticationServiceBean

java.lang.Object

com.haulmont.cuba.security.auth.AuthenticationServiceBean

All Implemented Interfaces:

AuthenticationService

@Component(value="cuba_AuthenticationService")
public class AuthenticationServiceBean
extends java.lang.Object
implements AuthenticationService

Field Summary

Fields

Modifier and Type	Field and Description
protected Authentication	authentication
protected AuthenticationManager	authenticationManager
protected TrustedLoginHandler	trustedLoginHandler
protected UserSessionLog	userSessionLog
protected UserSessionSource	userSessionSource

Fields inherited from interface com.haulmont.cuba.security.auth.AuthenticationService

NAME

Constructor Summary

Constructors

Constructor and Description
AuthenticationServiceBean()

Method Summary

Modifier and Type	Method and Description
AuthenticationDetails	authenticate(Credentials credentials) Authenticates a user and provides authentication details.
AuthenticationDetails	login(Credentials credentials) Authenticates a user, starts session and provides authentication details.
void	logout() Log out and destroy an active user session.
protected void	preprocessCredentials(Credentials credentials)
UserSession	substituteUser(User substitutedUser) Substitute a user, obtaining all its security related environment.
protected LoginException	wrapInLoginException(java.lang.Throwable throwable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

authenticationManager

@Inject
protected AuthenticationManager authenticationManager

userSessionSource

@Inject
protected UserSessionSource userSessionSource

userSessionLog

@Inject
protected UserSessionLog userSessionLog

authentication

@Inject
protected Authentication authentication

trustedLoginHandler

@Inject
protected TrustedLoginHandler trustedLoginHandler

Constructor Detail

AuthenticationServiceBean

public AuthenticationServiceBean()

Method Detail

authenticate

@Nonnull
public AuthenticationDetails authenticate(Credentials credentials)
                                            throws LoginException

Description copied from interface: AuthenticationService

Authenticates a user and provides authentication details. Does not start session. Obtained session cannot be used for service requests.

Specified by:

authenticate in interface AuthenticationService

Parameters:

credentials - credentials

Returns:

authentication details

Throws:

LoginException - if authentication fails

login

@Nonnull
public AuthenticationDetails login(Credentials credentials)
                                     throws LoginException

Description copied from interface: AuthenticationService

Authenticates a user, starts session and provides authentication details. Obtained session can be used for service requests.

Specified by:

login in interface AuthenticationService

Parameters:

credentials - credentials

Returns:

authentication details

Throws:

LoginException - if authentication fails

substituteUser

@Nonnull
public UserSession substituteUser(User substitutedUser)

Description copied from interface: AuthenticationService

Substitute a user, obtaining all its security related environment.
This method replaces an active UserSession with the new one, which is returned.

Specified by:

substituteUser in interface AuthenticationService

Parameters:

substitutedUser - a user to substitute. Must be in the current users' User.getSubstitutions() list.

Returns:

new UserSession instance that contains:

• id - the previously active user session id
• user - the logged in user
• substitutedUser - the user passed to this method
• all security data - loaded for the substitutedUser

logout

public void logout()

Description copied from interface: AuthenticationService

Log out and destroy an active user session.

Specified by:

logout in interface AuthenticationService

wrapInLoginException

protected LoginException wrapInLoginException(java.lang.Throwable throwable)

preprocessCredentials

protected void preprocessCredentials(Credentials credentials)