Package org.springframework.vault.authentication

Class ResourceCredentialSupplier

java.lang.Object

org.springframework.vault.authentication.ResourceCredentialSupplier

All Implemented Interfaces:

Supplier<String>, CredentialSupplier

Direct Known Subclasses:

KubernetesServiceAccountTokenFile

public class ResourceCredentialSupplier
extends Object
implements CredentialSupplier

Mechanism to retrieve a credential from a Resource.

Since:

2.2

Author:

Mark Paluch

See Also:

• CredentialSupplier

Constructor Summary

Constructors

Constructor	Description
ResourceCredentialSupplier(File file)	Create a new ResourceCredentialSupplier ResourceCredentialSupplier from a File handle.
ResourceCredentialSupplier(String path)	Create a new ResourceCredentialSupplier ResourceCredentialSupplier from a path.
ResourceCredentialSupplier(Resource resource)	Create a new ResourceCredentialSupplier ResourceCredentialSupplier from a Resource handle.

Method Summary

Modifier and Type	Method	Description
String	get()	Get a credential to be used with an authentication mechanism.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.vault.authentication.CredentialSupplier

cached

Constructor Details

ResourceCredentialSupplier

public ResourceCredentialSupplier(String path)

Create a new ResourceCredentialSupplier ResourceCredentialSupplier from a path.

Parameters:

path - path to the file holding the credential.

Throws:

IllegalArgumentException - if thepath does not exist.

ResourceCredentialSupplier

public ResourceCredentialSupplier(File file)

Create a new ResourceCredentialSupplier ResourceCredentialSupplier from a File handle.

Parameters:

file - path to the file holding the credential.

Throws:

IllegalArgumentException - if thepath does not exist.

ResourceCredentialSupplier

public ResourceCredentialSupplier(Resource resource)

Create a new ResourceCredentialSupplier ResourceCredentialSupplier from a Resource handle.

Parameters:

resource - resource pointing to the resource holding the credential.

Throws:

IllegalArgumentException - if the Resource does not exist.

Method Details

get

public String get()

Description copied from interface: CredentialSupplier

Get a credential to be used with an authentication mechanism.

Specified by:

get in interface CredentialSupplier

Specified by:

get in interface Supplier<String>

Returns:

the credential.