org.springframework.vault.authentication

Interface AppRoleAuthenticationOptions.RoleId

Enclosing class:

AppRoleAuthenticationOptions

public static interface AppRoleAuthenticationOptions.RoleId

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

Since:

2.0

Method Summary

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

Method Detail

wrapped

static AppRoleAuthenticationOptions.RoleId wrapped(VaultToken initialToken)

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

Parameters:

initialToken - must not be null.

Returns:

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

See Also:

VaultResponses.unwrap(String, Class)

pull

static AppRoleAuthenticationOptions.RoleId pull(VaultToken initialToken)

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

Parameters:

initialToken - must not be null.

Returns:

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

provided

static AppRoleAuthenticationOptions.RoleId provided(String roleId)

Create a AppRoleAuthenticationOptions.RoleId that encapsulates a static roleId.

Parameters:

roleId - must not be null or empty.

Returns:

AppRoleAuthenticationOptions.RoleId that encapsulates a static roleId.