Package land.oras.auth

Class AuthStoreAuthenticationProvider

java.lang.Object

land.oras.auth.AuthStoreAuthenticationProvider

All Implemented Interfaces:

AuthProvider

@NullMarked
public final class AuthStoreAuthenticationProvider
extends Object
implements AuthProvider

AuthStoreAuthenticationProvider is an implementation of the AuthProvider interface. It retrieves credentials from a AuthStore and generates a Basic Authentication header.

Constructor Summary

Constructors

Constructor	Description
AuthStoreAuthenticationProvider()	Default constructor
AuthStoreAuthenticationProvider(AuthStore authStore)	Constructor.

Method Summary

Modifier and Type	Method	Description
@Nullable String	getAuthHeader(ContainerRef registry)	Get the authentication header for this provider
AuthScheme	getAuthScheme()	Get the authentication scheme for this provider
String	getIdentity(ContainerRef registry)	Get an opaque identity marker for the credentials this provider resolves for the given registry.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthStoreAuthenticationProvider

public AuthStoreAuthenticationProvider()

Default constructor

AuthStoreAuthenticationProvider

public AuthStoreAuthenticationProvider(AuthStore authStore)

Constructor.

Parameters:

authStore - The FileStore instance to retrieve credentials from.

Method Details

getAuthHeader

public @Nullable String getAuthHeader(ContainerRef registry)

Description copied from interface: AuthProvider

Get the authentication header for this provider

Specified by:

getAuthHeader in interface AuthProvider

Parameters:

registry - The registry

Returns:

The authentication header or null if not applicable

getAuthScheme

public AuthScheme getAuthScheme()

Description copied from interface: AuthProvider

Get the authentication scheme for this provider

Specified by:

getAuthScheme in interface AuthProvider

Returns:

The authentication scheme

getIdentity

public String getIdentity(ContainerRef registry)

Description copied from interface: AuthProvider

Get an opaque identity marker for the credentials this provider resolves for the given registry. This marker is used to key TokenCache entries alongside the requested Scopes

Specified by:

getIdentity in interface AuthProvider

Parameters:

registry - The registry

Returns:

A non-null identity marker