com.haulmont.cuba.security.auth

Interface AuthenticationProvider

All Known Implementing Classes:

AbstractAuthenticationProvider, AnonymousAuthenticationProvider, LoginPasswordAuthenticationProvider, RememberMeAuthenticationProvider, SystemAuthenticationProvider, TrustedClientAuthenticationProvider

public interface AuthenticationProvider

Authentication module that can process a specific Credentials implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGHEST_PLATFORM_PRECEDENCE Defines the highest precedence for Ordered providers of the platform.
static int	LOWEST_PLATFORM_PRECEDENCE Defines the lowest precedence for Ordered providers of the platform.

Method Summary

Modifier and Type	Method and Description
AuthenticationDetails	authenticate(Credentials credentials) Authenticates a user and provides authentication details.
boolean	supports(java.lang.Class<?> credentialsClass) Checks if this provider supports passed credentials class or not.

Field Detail

HIGHEST_PLATFORM_PRECEDENCE

static final int HIGHEST_PLATFORM_PRECEDENCE

Defines the highest precedence for Ordered providers of the platform.

See Also:

Constant Field Values

LOWEST_PLATFORM_PRECEDENCE

static final int LOWEST_PLATFORM_PRECEDENCE

Defines the lowest precedence for Ordered providers of the platform.

See Also:

Constant Field Values

Method Detail

authenticate

@Nullable
AuthenticationDetails authenticate(Credentials credentials)
                                      throws LoginException

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

Parameters:

credentials - credentials

Returns:

authentication details or null if passed credentials object cannot be processed

Throws:

LoginException - if authentication fails

supports

boolean supports(java.lang.Class<?> credentialsClass)

Checks if this provider supports passed credentials class or not.

Parameters:

credentialsClass - credentials class

Returns:

true if this provider supports the indicated Credentials object.