com.haulmont.cuba.security.auth

Class AuthenticationManagerBean

java.lang.Object

com.haulmont.cuba.security.auth.AuthenticationManagerBean

All Implemented Interfaces:

AuthenticationManager

@Component(value="cuba_AuthenticationManager")
public class AuthenticationManagerBean
extends java.lang.Object
implements AuthenticationManager

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<AuthenticationProvider>	authenticationProviders
protected ClusterManager	clusterManager
protected Events	events
protected Persistence	persistence
protected UserSession	serverSession
protected UserSessionManager	userSessionManager
protected UserSessionsAPI	userSessions
protected UserSessionSource	userSessionSource

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

NAME

Constructor Summary

Constructors

Constructor and Description
AuthenticationManagerBean()

Method Summary

Modifier and Type	Method and Description
AuthenticationDetails	authenticate(Credentials credentials) Authenticates a user and provides authentication details.
protected AuthenticationDetails	authenticateInternal(Credentials credentials)
protected java.util.List<AuthenticationProvider>	getProviders()
protected User	loadSubstitutedUser(User substitutedUser, UserSession currentSession, EntityManager em)
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	publishAfterAuthenticationEvent(Credentials credentials, AuthenticationDetails authenticationDetails)
protected void	publishAfterLoginEvent(Credentials credentials, AuthenticationDetails authenticationDetails)
protected void	publishAuthenticationFailed(Credentials credentials, AuthenticationProvider provider, LoginException e)
protected void	publishAuthenticationSuccess(AuthenticationDetails details, Credentials credentials)
protected void	publishBeforeAuthenticationEvent(Credentials credentials)
protected void	publishBeforeLoginEvent(Credentials credentials)
protected void	publishUserLoggedInEvent(Credentials credentials, AuthenticationDetails authenticationDetails)
protected void	publishUserLoggedOut(UserSession session)
protected void	publishUserSubstitutedEvent(UserSession currentSession, UserSession substitutedSession)
protected void	setSessionAttributes(Credentials credentials, AuthenticationDetails authenticationDetails)
protected void	setTimeZone(Credentials credentials, AuthenticationDetails authenticationDetails)
protected void	storeSession(Credentials credentials, AuthenticationDetails authenticationDetails)
UserSession	substituteUser(User substitutedUser) Substitute a user, obtaining all its security related environment.

Methods inherited from class java.lang.Object

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

Field Detail

events

@Inject
protected Events events

userSessionSource

@Inject
protected UserSessionSource userSessionSource

userSessionManager

@Inject
protected UserSessionManager userSessionManager

userSessions

@Inject
protected UserSessionsAPI userSessions

persistence

@Inject
protected Persistence persistence

clusterManager

@Inject
protected ClusterManager clusterManager

authenticationProviders

@Inject
protected java.util.List<AuthenticationProvider> authenticationProviders

serverSession

protected UserSession serverSession

Constructor Detail

AuthenticationManagerBean

public AuthenticationManagerBean()

Method Detail

authenticate

@Nonnull
public AuthenticationDetails authenticate(Credentials credentials)
                                            throws LoginException

Description copied from interface: AuthenticationManager

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

Specified by:

authenticate in interface AuthenticationManager

Parameters:

credentials - credentials

Returns:

authentication details

Throws:

LoginException - if authentication fails

login

@Nonnull
public AuthenticationDetails login(Credentials credentials)
                                     throws LoginException

Description copied from interface: AuthenticationManager

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

Specified by:

login in interface AuthenticationManager

Parameters:

credentials - credentials

Returns:

authentication details

Throws:

LoginException - if authentication fails

setTimeZone

protected void setTimeZone(Credentials credentials,
                           AuthenticationDetails authenticationDetails)

setSessionAttributes

protected void setSessionAttributes(Credentials credentials,
                                    AuthenticationDetails authenticationDetails)

storeSession

protected void storeSession(Credentials credentials,
                            AuthenticationDetails authenticationDetails)

substituteUser

@Nonnull
public UserSession substituteUser(User substitutedUser)

Description copied from interface: AuthenticationManager

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 AuthenticationManager

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

See Also:

AuthenticationService.substituteUser(User)

logout

public void logout()

Description copied from interface: AuthenticationManager

Log out and destroy an active user session.

Specified by:

logout in interface AuthenticationManager

See Also:

AuthenticationService.logout()

authenticateInternal

protected AuthenticationDetails authenticateInternal(Credentials credentials)
                                              throws LoginException

Throws:

LoginException

loadSubstitutedUser

protected User loadSubstitutedUser(User substitutedUser,
                                   UserSession currentSession,
                                   EntityManager em)

publishAfterLoginEvent

protected void publishAfterLoginEvent(Credentials credentials,
                                      AuthenticationDetails authenticationDetails)

publishUserSubstitutedEvent

protected void publishUserSubstitutedEvent(UserSession currentSession,
                                           UserSession substitutedSession)

publishUserLoggedInEvent

protected void publishUserLoggedInEvent(Credentials credentials,
                                        AuthenticationDetails authenticationDetails)

publishBeforeLoginEvent

protected void publishBeforeLoginEvent(Credentials credentials)
                                throws LoginException

Throws:

LoginException

publishBeforeAuthenticationEvent

protected void publishBeforeAuthenticationEvent(Credentials credentials)
                                         throws LoginException

Throws:

LoginException

publishAfterAuthenticationEvent

protected void publishAfterAuthenticationEvent(Credentials credentials,
                                               AuthenticationDetails authenticationDetails)
                                        throws LoginException

Throws:

LoginException

publishAuthenticationFailed

protected void publishAuthenticationFailed(Credentials credentials,
                                           AuthenticationProvider provider,
                                           LoginException e)
                                    throws LoginException

Throws:

LoginException

publishAuthenticationSuccess

protected void publishAuthenticationSuccess(AuthenticationDetails details,
                                            Credentials credentials)
                                     throws LoginException

Throws:

LoginException

publishUserLoggedOut

protected void publishUserLoggedOut(UserSession session)

getProviders

protected java.util.List<AuthenticationProvider> getProviders()