com.haulmont.cuba.security.auth

Interface AuthenticationService

All Known Implementing Classes:

AuthenticationServiceBean

public interface AuthenticationService

Authentication layer for client applications.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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.
UserSession	substituteUser(User substitutedUser) Substitute a user, obtaining all its security related environment.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

authenticate

@Nonnull
AuthenticationDetails authenticate(Credentials credentials)
                                     throws LoginException

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

Parameters:

credentials - credentials

Returns:

authentication details

Throws:

LoginException - if authentication fails

login

@Nonnull
AuthenticationDetails login(Credentials credentials)
                              throws LoginException

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

Parameters:

credentials - credentials

Returns:

authentication details

Throws:

LoginException - if authentication fails

substituteUser

@Nonnull
UserSession substituteUser(User substitutedUser)

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

Parameters:

substitutedUser - a user to substitute. Must be in the current users' User.substitutions 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

void logout()

Log out and destroy an active user session.

Throws:

NoUserSessionException - if session is absent or expired