org.springframework.vault.authentication

Class PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder

Enclosing class:

PcfAuthenticationOptions

public static class PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder
extends Object

Builder for PcfAuthenticationOptions.

Method Summary

Modifier and Type	Method and Description
PcfAuthenticationOptions	build() Build a new PcfAuthenticationOptions instance.
PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder	clock(Clock clock) Configure the Clock.
PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder	instanceCertificate(Supplier<String> instanceCertSupplier) Configure the Supplier to obtain the instance certificate.
PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder	instanceKey(Supplier<String> instanceKeySupplier) Configure the Supplier to obtain the instance key.
PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder	path(String path) Configure the mount path.
PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder	role(String role) Configure the role.

Methods inherited from class java.lang.Object

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

Method Detail

path

public PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder path(String path)

Configure the mount path.

Parameters:

path - must not be empty or null.

Returns:

this PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.

See Also:

PcfAuthenticationOptions.DEFAULT_PCF_AUTHENTICATION_PATH

role

public PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder role(String role)

Configure the role.

Parameters:

role - name of the role against which the login is being attempted, must not be null or empty.

Returns:

this PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.

clock

public PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder clock(Clock clock)

Configure the Clock.

Parameters:

clock - must not be null.

Returns:

this PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.

instanceCertificate

public PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder instanceCertificate(Supplier<String> instanceCertSupplier)

Configure the Supplier to obtain the instance certificate.

Parameters:

instanceCertSupplier - the supplier, must not be null.

Returns:

this PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.

See Also:

ResourceCredentialSupplier

instanceKey

public PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder instanceKey(Supplier<String> instanceKeySupplier)

Configure the Supplier to obtain the instance key.

Parameters:

instanceKeySupplier - the supplier, must not be null.

Returns:

this PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.

See Also:

ResourceCredentialSupplier

build

public PcfAuthenticationOptions build()

Build a new PcfAuthenticationOptions instance.

Falls back to the instance certificate at CF_INSTANCE_CERT if instanceCertificate(Supplier) is not configured respective CF_INSTANCE_KEY if instanceKey(Supplier) is not configured.

Returns:

a new PcfAuthenticationOptions.

Throws:

IllegalStateException - if instanceCertificate(Supplier) or instanceKey(Supplier) are not set and the corresponding environment variable CF_INSTANCE_CERT respective CF_INSTANCE_KEY is not set.