org.springframework.vault.authentication

Class AppRoleAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.AppRoleAuthenticationOptions

public class AppRoleAuthenticationOptions
extends Object

Authentication options for AppRoleAuthentication.

Authentication options provide the path, roleId and pull/push mode. AppRoleAuthentication can be constructed using builder(). Instances of this class are immutable once constructed.

Author:

Mark Paluch, Vincent Le Nair, Christophe Tafani-Dereeper

See Also:

AppRoleAuthentication, builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder Builder for AppRoleAuthenticationOptions.
static interface	AppRoleAuthenticationOptions.RoleId RoleId type encapsulating how the roleId is actually obtained.
static interface	AppRoleAuthenticationOptions.SecretId SecretId type encapsulating how the secretId is actually obtained.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_APPROLE_AUTHENTICATION_PATH

Method Summary

Modifier and Type	Method and Description
static AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	builder()
String	getAppRole()
VaultToken	getInitialToken() Deprecated. since 2.0, use getRoleId()/getSecretId() to obtain configuration modes (pull/wrapped) for an AppRole token.
String	getPath()
AppRoleAuthenticationOptions.RoleId	getRoleId()
AppRoleAuthenticationOptions.SecretId	getSecretId()
UnwrappingEndpoints	getUnwrappingEndpoints()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_APPROLE_AUTHENTICATION_PATH

public static final String DEFAULT_APPROLE_AUTHENTICATION_PATH

See Also:

Constant Field Values

Method Detail

builder

public static AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder builder()

Returns:

a new AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

getPath

public String getPath()

Returns:

the mount path.

getRoleId

public AppRoleAuthenticationOptions.RoleId getRoleId()

Returns:

the RoleId.

getSecretId

public AppRoleAuthenticationOptions.SecretId getSecretId()

Returns:

the bound SecretId.

getAppRole

@Nullable
public String getAppRole()

Returns:

the bound AppRole.

Since:

1.1

getUnwrappingEndpoints

public UnwrappingEndpoints getUnwrappingEndpoints()

Returns:

the endpoint configuration.

Since:

2.2

getInitialToken

@Nullable
 @Deprecated
public VaultToken getInitialToken()

Deprecated. since 2.0, use getRoleId()/getSecretId() to obtain configuration modes (pull/wrapped) for an AppRole token.

Returns:

the initial token for roleId/secretId retrieval in pull mode.

Since:

1.1