Package org.springframework.vault.authentication

Class CubbyholeAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.CubbyholeAuthenticationOptions

public class CubbyholeAuthenticationOptions
extends Object

Authentication options for CubbyholeAuthentication.

Authentication options provide the path below cubbyhole and the cubbyhole mode. Instances of this class are immutable once constructed.

Author:

Mark Paluch

See Also:

• CubbyholeAuthentication
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder	Builder for CubbyholeAuthenticationOptions.

Method Summary

Modifier and Type	Method	Description
static CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder	builder()
VaultToken	getInitialToken()
String	getPath()
UnwrappingEndpoints	getUnwrappingEndpoints()
boolean	isSelfLookup()
boolean	isWrappedToken()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder builder()

Returns:

a new CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder.

getInitialToken

public VaultToken getInitialToken()

Returns:

the initial VaultToken to access Cubbyhole.

getPath

public String getPath()

Returns:

the path of the Cubbyhole response path.

getUnwrappingEndpoints

public UnwrappingEndpoints getUnwrappingEndpoints()

Returns:

the endpoint configuration.

Since:

2.2

isWrappedToken

public boolean isWrappedToken()

Returns:

true indicates that the Cubbyhole response contains a wrapped token, otherwise false to expect a token in the data response.

isSelfLookup

public boolean isSelfLookup()

Returns:

true to perform a token self-lookup after token retrieval to determine the remaining TTL and renewability for static wrapped tokens. Defaults to true.

Since:

1.0.1