Package org.apache.polaris.service.auth

Class DefaultAuthenticator

java.lang.Object

org.apache.polaris.service.auth.DefaultAuthenticator

All Implemented Interfaces:

Authenticator<PrincipalAuthInfo,org.apache.polaris.core.auth.AuthenticatedPolarisPrincipal>

@RequestScoped
@Identifier("default")
public class DefaultAuthenticator
extends Object
implements Authenticator<PrincipalAuthInfo,org.apache.polaris.core.auth.AuthenticatedPolarisPrincipal>

The default authenticator that resolves a PrincipalAuthInfo to an AuthenticatedPolarisPrincipal.

This authenticator is used in both internal and external authentication scenarios.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRINCIPAL_ROLE_ALL
static final String	PRINCIPAL_ROLE_PREFIX

Constructor Summary

Constructors

Constructor	Description
DefaultAuthenticator()

Method Summary

Modifier and Type	Method	Description
Optional<org.apache.polaris.core.auth.AuthenticatedPolarisPrincipal>	authenticate(PrincipalAuthInfo credentials)	Authenticates the given credentials and returns an optional principal.

Methods inherited from class java.lang.Object

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

Field Details

PRINCIPAL_ROLE_ALL

public static final String PRINCIPAL_ROLE_ALL

See Also:

• Constant Field Values

PRINCIPAL_ROLE_PREFIX

public static final String PRINCIPAL_ROLE_PREFIX

See Also:

• Constant Field Values

Constructor Details

DefaultAuthenticator

public DefaultAuthenticator()

Method Details

authenticate

public Optional<org.apache.polaris.core.auth.AuthenticatedPolarisPrincipal> authenticate(PrincipalAuthInfo credentials)

Description copied from interface: Authenticator

Authenticates the given credentials and returns an optional principal.

If the credentials are not valid or if the authentication fails, implementations may choose to return an empty optional or throw an exception. Returning empty will generally translate into a NotAuthorizedException.

Specified by:

authenticate in interface Authenticator<PrincipalAuthInfo,org.apache.polaris.core.auth.AuthenticatedPolarisPrincipal>

Parameters:

credentials - the credentials to authenticate

Returns:

an optional principal if authentication is successful, or an empty optional if authentication fails.