Package org.springframework.vault.authentication

Class AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder

Enclosing class:

AppRoleAuthenticationOptions

public static class AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder
extends Object

Builder for AppRoleAuthenticationOptions.

Method Summary

Modifier and Type	Method	Description
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	appRole(String appRole)	Configure a appRole.
AppRoleAuthenticationOptions	build()	Build a new AppRoleAuthenticationOptions instance.
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	initialToken(VaultToken initialToken)	Deprecated. since 2.0, use roleId(AppRoleAuthenticationOptions.RoleId)/secretId(AppRoleAuthenticationOptions.SecretId) to configure pull mode.
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	path(String path)	Configure the mount path.
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	roleId(String roleId)	Deprecated. since 2.0, use roleId(AppRoleAuthenticationOptions.RoleId).
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	roleId(AppRoleAuthenticationOptions.RoleId roleId)	Configure the RoleId.
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	secretId(String secretId)	Deprecated. since 2.0, use secretId(AppRoleAuthenticationOptions.SecretId).
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	secretId(AppRoleAuthenticationOptions.SecretId secretId)	Configure a secretId.
AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder	unwrappingEndpoints(UnwrappingEndpoints endpoints)	Configure the UnwrappingEndpoints to use.

Methods inherited from class java.lang.Object

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

Method Details

path

public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder path(String path)

Configure the mount path.

Parameters:

path - must not be empty or null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

See Also:

• AppRoleAuthenticationOptions.DEFAULT_APPROLE_AUTHENTICATION_PATH

roleId

public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder roleId(AppRoleAuthenticationOptions.RoleId roleId)

Configure the RoleId.

Parameters:

roleId - must not be empty or null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

Since:

2.0

roleId

@Deprecated
public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder roleId(String roleId)

Deprecated.

since 2.0, use roleId(AppRoleAuthenticationOptions.RoleId).

Configure the RoleId.

Parameters:

roleId - must not be empty or null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

secretId

public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder secretId(AppRoleAuthenticationOptions.SecretId secretId)

Configure a secretId.

Parameters:

secretId - must not be empty or null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

Since:

2.0

secretId

@Deprecated
public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder secretId(String secretId)

Deprecated.

since 2.0, use secretId(AppRoleAuthenticationOptions.SecretId).

Configure a secretId.

Parameters:

secretId - must not be empty or null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

appRole

public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder appRole(String appRole)

Configure a appRole.

Parameters:

appRole - must not be empty or null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

Since:

1.1

unwrappingEndpoints

public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder unwrappingEndpoints(UnwrappingEndpoints endpoints)

Configure the UnwrappingEndpoints to use.

Parameters:

endpoints - must not be null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder

Since:

2.2

initialToken

@Deprecated
public AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder initialToken(VaultToken initialToken)

Deprecated.

since 2.0, use roleId(AppRoleAuthenticationOptions.RoleId)/secretId(AppRoleAuthenticationOptions.SecretId) to configure pull mode.

Configure a initialToken.

Parameters:

initialToken - must not be empty or null.

Returns:

this AppRoleAuthenticationOptions.AppRoleAuthenticationOptionsBuilder.

Since:

1.1

build

public AppRoleAuthenticationOptions build()

Build a new AppRoleAuthenticationOptions instance. Requires roleId(String) for push mode or appRole(String) and initialToken(VaultToken) for pull mode to be configured.

Returns:

a new AppRoleAuthenticationOptions.