Interface Authenticator

All Known Implementing Classes:
DefaultAuthenticator

public interface Authenticator
An interface for authenticating principals based on provided credentials.

Authenticators are used in both internal and external authentication scenarios.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.polaris.core.auth.PolarisPrincipal
    Authenticates the given PolarisCredential and returns an authenticated PolarisPrincipal.
  • Method Details

    • authenticate

      org.apache.polaris.core.auth.PolarisPrincipal authenticate(PolarisCredential credentials) throws org.apache.iceberg.exceptions.NotAuthorizedException, org.apache.iceberg.exceptions.ServiceFailureException
      Authenticates the given PolarisCredential and returns an authenticated PolarisPrincipal.

      If the credentials are not valid or if the authentication fails, implementations MUST throw NotAuthorizedException.

      Parameters:
      credentials - the credentials to authenticate
      Returns:
      the authenticated principal
      Throws:
      org.apache.iceberg.exceptions.NotAuthorizedException - if the credentials are not authorized
      org.apache.iceberg.exceptions.ServiceFailureException - if there is a failure in the authentication service