org.springframework.vault.authentication

Interface CredentialSupplier

All Superinterfaces:

Supplier<String>

All Known Subinterfaces:

KubernetesJwtSupplier

All Known Implementing Classes:

KubernetesServiceAccountTokenFile, ResourceCredentialSupplier

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CredentialSupplier
extends Supplier<String>

Interface to obtain an arbitrary credential that is uses in ClientAuthentication or AuthenticationSteps methods. Typically, implementations obtain their credential from a file.

Since:

2.2

Author:

Mark Paluch

See Also:

ResourceCredentialSupplier

Method Summary

Modifier and Type	Method and Description
default CredentialSupplier	cached() Retrieve a cached CredentialSupplier that obtains the credential early and reuses the token for each get() call.
String	get() Get a credential to be used with an authentication mechanism.

Method Detail

get

String get()

Get a credential to be used with an authentication mechanism.

Specified by:

get in interface Supplier<String>

Returns:

the credential.

cached

default CredentialSupplier cached()

Retrieve a cached CredentialSupplier that obtains the credential early and reuses the token for each get() call. This is useful to prevent I/O operations in e.g. reactive usage.

Reusing a cached token can lead to authentication failures if the credential expires.

Returns:

a caching CredentialSupplier.