Package org.springframework.vault.authentication

Interface AppRoleAuthenticationOptions.SecretId

Enclosing class:

AppRoleAuthenticationOptions

public static interface AppRoleAuthenticationOptions.SecretId

SecretId type encapsulating how the secretId is actually obtained. Provides factory methods to obtain a AppRoleAuthenticationOptions.SecretId by wrapping, pull-mode or whether to use a string literal.

Since:

2.0

Method Summary

Static Methods

Modifier and Type	Method	Description
static AppRoleAuthenticationOptions.SecretId	absent()	Create a AppRoleAuthenticationOptions.SecretId that represents an absent secretId.
static AppRoleAuthenticationOptions.SecretId	provided(String secretId)	Create a AppRoleAuthenticationOptions.SecretId that encapsulates a static secretId.
static AppRoleAuthenticationOptions.SecretId	pull(VaultToken initialToken)	Create a AppRoleAuthenticationOptions.SecretId that obtains its value using pull-mode, specifying a initial token.
static AppRoleAuthenticationOptions.SecretId	wrapped(VaultToken initialToken)	Create a AppRoleAuthenticationOptions.SecretId object that obtains its value from unwrapping a response using the initial token from a Cubbyhole.

Method Details

wrapped

static AppRoleAuthenticationOptions.SecretId wrapped(VaultToken initialToken)

Create a AppRoleAuthenticationOptions.SecretId object that obtains its value from unwrapping a response using the initial token from a Cubbyhole.

Parameters:

initialToken - must not be null.

Returns:

AppRoleAuthenticationOptions.SecretId object that obtains its value from unwrapping a response using the initial token.

See Also:

• VaultResponses.unwrap(String, Class)

pull

static AppRoleAuthenticationOptions.SecretId pull(VaultToken initialToken)

Create a AppRoleAuthenticationOptions.SecretId that obtains its value using pull-mode, specifying a initial token. The token policy must allow reading the SecretId from auth/approle/role/(role-name)/secret-id.

Parameters:

initialToken - must not be null.

Returns:

AppRoleAuthenticationOptions.SecretId that obtains its value using pull-mode.

provided

static AppRoleAuthenticationOptions.SecretId provided(String secretId)

Create a AppRoleAuthenticationOptions.SecretId that encapsulates a static secretId.

Parameters:

secretId - must not be null or empty.

Returns:

AppRoleAuthenticationOptions.SecretId that encapsulates a static SecretId.

absent

static AppRoleAuthenticationOptions.SecretId absent()

Create a AppRoleAuthenticationOptions.SecretId that represents an absent secretId. Using this object will not send a secretId during AppRole login.

Returns:

a AppRoleAuthenticationOptions.SecretId that represents an absent secretId