Package org.springframework.vault.authentication

Class PcfAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.PcfAuthenticationOptions

public class PcfAuthenticationOptions
extends Object

Authentication options for PcfAuthentication.

Authentication options provide the path, Clock and instance key/instance certificate Suppliers. PcfAuthenticationOptions can be constructed using builder(). Instances of this class are immutable once constructed.

Defaults to platform-default instance certificate/key by resolving CF_INSTANCE_CERT and CF_INSTANCE_KEY env variables.

Author:

Mark Paluch

See Also:

• CredentialSupplier
• ResourceCredentialSupplier
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder	Builder for PcfAuthenticationOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PCF_AUTHENTICATION_PATH

Method Summary

Modifier and Type	Method	Description
static PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder	builder()
Clock	getClock()
Supplier<String>	getInstanceCertSupplier()
Supplier<String>	getInstanceKeySupplier()
String	getPath()
String	getRole()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PCF_AUTHENTICATION_PATH

public static final String DEFAULT_PCF_AUTHENTICATION_PATH

See Also:

• Constant Field Values

Method Details

builder

public static PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder builder()

Returns:

a new PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.

getPath

public String getPath()

Returns:

the path of the pcf authentication backend mount.

getRole

public String getRole()

Returns:

name of the role against which the login is being attempted.

getClock

public Clock getClock()

Returns:

the Clock.

getInstanceCertSupplier

public Supplier<String> getInstanceCertSupplier()

Returns:

the instance certificate Supplier.

getInstanceKeySupplier

public Supplier<String> getInstanceKeySupplier()

Returns:

the instance key Supplier.