Package org.apache.iceberg.rest.auth

Interface AuthManager

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
BasicAuthManager, NoopAuthManager, OAuth2Manager, RefreshingAuthManager, RESTSigV4AuthManager
public interface AuthManager extends AutoCloseable
Manager for authentication sessions. This interface is used to create sessions for the catalog, the tables/views, and any other context that requires authentication.

Managers are usually stateful and may require initialization and cleanup. The manager is created by the catalog and is closed when the catalog is closed.

  • Method Details

    • initSession

      default AuthSession initSession(RESTClient initClient, Map<String,String> properties)
      Returns a temporary session to use for contacting the configuration endpoint only. Note that the returned session will be closed after the configuration endpoint is contacted, and should not be cached.

      The provided REST client is a short-lived client; it should only be used to fetch initial credentials, if required, and must be discarded after that.

      This method cannot return null. By default, it returns the catalog session.

    • catalogSession

      AuthSession catalogSession(RESTClient sharedClient, Map<String,String> properties)
      Returns a long-lived session whose lifetime is tied to the owning catalog. This session serves as the parent session for all other sessions (contextual and table-specific). It is closed when the owning catalog is closed.

      The provided REST client is a long-lived, shared client; if required, implementors may store it and reuse it for all subsequent requests to the authorization server, e.g. for renewing or refreshing credentials. It is not necessary to close it when close() is called.

      This method cannot return null.

      It is not required to cache the returned session internally, as the catalog will keep it alive for the lifetime of the catalog.

    • contextualSession

      default AuthSession contextualSession(SessionCatalog.SessionContext context, AuthSession parent)
      Returns a session for a specific context.

      If the context requires a specific AuthSession, this method should return a new AuthSession instance, otherwise it should return the parent session.

      This method cannot return null. By default, it returns the parent session.

      Implementors should cache contextual sessions internally, as the catalog will not cache them. Also, the owning catalog never closes contextual sessions; implementations should manage their lifecycle themselves and close them when they are no longer needed.

    • tableSession

      default AuthSession tableSession(TableIdentifier table, Map<String,String> properties, AuthSession parent)
      Returns a new session targeting a specific table or view. The properties are the ones returned by the table/view endpoint.

      If the table or view requires a specific AuthSession, this method should return a new AuthSession instance, otherwise it should return the parent session.

      This method cannot return null. By default, it returns the parent session.

      Implementors should cache table sessions internally, as the catalog will not cache them. Also, the owning catalog never closes table sessions; implementations should manage their lifecycle themselves and close them when they are no longer needed.

    • close

      void close()
      Closes the manager and releases any resources.

      This method is called when the owning catalog is closed.

      Specified by:
      close in interface AutoCloseable