org.springframework.vault.support

Class VaultTokenRequest.VaultTokenRequestBuilder

java.lang.Object

org.springframework.vault.support.VaultTokenRequest.VaultTokenRequestBuilder

Enclosing class:

VaultTokenRequest

public static class VaultTokenRequest.VaultTokenRequestBuilder
extends Object

Builder to build a VaultTokenRequest.

Method Summary

Modifier and Type	Method and Description
VaultTokenRequest	build() Build a new VaultTokenRequest instance.
VaultTokenRequest.VaultTokenRequestBuilder	displayName(String displayName) Configure a display name for the token, defaults to "token".
VaultTokenRequest.VaultTokenRequestBuilder	explicitMaxTtl(Duration explicitMaxTtl) Configure the explicit maximum TTL for the token.
VaultTokenRequest.VaultTokenRequestBuilder	explicitMaxTtl(long explicitMaxTtl) Deprecated. since 2.0, use explicitMaxTtl(Duration) for time unit safety.
VaultTokenRequest.VaultTokenRequestBuilder	explicitMaxTtl(long explicitMaxTtl, TimeUnit timeUnit) Configure the explicit maximum TTL for the token.
VaultTokenRequest.VaultTokenRequestBuilder	id(String id) Configure a the Id of the client token.
VaultTokenRequest.VaultTokenRequestBuilder	meta(Map<String,String> meta) Configure meta.
VaultTokenRequest.VaultTokenRequestBuilder	noDefaultPolicy() Omit the default policy in the token's policy set
VaultTokenRequest.VaultTokenRequestBuilder	noDefaultPolicy(boolean noDefaultPolicy) Configure whether the default policy should be part of the token's policy set.
VaultTokenRequest.VaultTokenRequestBuilder	noParent() Configure the token to not have the parent token of the caller.
VaultTokenRequest.VaultTokenRequestBuilder	noParent(boolean noParent) Configure the token to not have the parent token of the caller.
VaultTokenRequest.VaultTokenRequestBuilder	numUses(int numUses) Configure the maximum uses for the token.
VaultTokenRequest.VaultTokenRequestBuilder	policies(Iterable<String> policies) Configure policies.
VaultTokenRequest.VaultTokenRequestBuilder	renewable() Enable TTL extension/renewal for the token.
VaultTokenRequest.VaultTokenRequestBuilder	renewable(boolean renewable) Configure TTL extension/renewal for the token.
VaultTokenRequest.VaultTokenRequestBuilder	ttl(Duration ttl) Configure a TTL for the token using ChronoUnit.SECONDS resolution.
VaultTokenRequest.VaultTokenRequestBuilder	ttl(long ttl) Deprecated. since 2.0, use ttl(Duration) for time unit safety.
VaultTokenRequest.VaultTokenRequestBuilder	ttl(long ttl, TimeUnit timeUnit) Configure a TTL (seconds) for the token.
VaultTokenRequest.VaultTokenRequestBuilder	withPolicy(String policy) Add a policy.

Methods inherited from class java.lang.Object

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

Method Detail

id

public VaultTokenRequest.VaultTokenRequestBuilder id(String id)

Configure a the Id of the client token. Can only be specified by a root token. Otherwise, the token Id is a randomly generated UUID.

Parameters:

id - the token Id.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

policies

public VaultTokenRequest.VaultTokenRequestBuilder policies(Iterable<String> policies)

Configure policies. Replaces previously configured policies.

Parameters:

policies - must not be null.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

withPolicy

public VaultTokenRequest.VaultTokenRequestBuilder withPolicy(String policy)

Add a policy.

Parameters:

policy - must not be empty or null.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

meta

public VaultTokenRequest.VaultTokenRequestBuilder meta(Map<String,String> meta)

Configure meta. Replaces previously meta.

Parameters:

meta - must not be null.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

noParent

public VaultTokenRequest.VaultTokenRequestBuilder noParent()

Configure the token to not have the parent token of the caller. This creates a token with no parent. Requires a root caller.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

noParent

public VaultTokenRequest.VaultTokenRequestBuilder noParent(boolean noParent)

Configure the token to not have the parent token of the caller. This creates a token with no parent. Requires a root caller.

Parameters:

noParent - true to not have the parent token of the caller.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

noDefaultPolicy

public VaultTokenRequest.VaultTokenRequestBuilder noDefaultPolicy()

Omit the default policy in the token's policy set

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

noDefaultPolicy

public VaultTokenRequest.VaultTokenRequestBuilder noDefaultPolicy(boolean noDefaultPolicy)

Configure whether the default policy should be part of the token's policy set.

Parameters:

noDefaultPolicy - true to omit the default policy in the token's policy set.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

renewable

public VaultTokenRequest.VaultTokenRequestBuilder renewable()

Enable TTL extension/renewal for the token.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

renewable

public VaultTokenRequest.VaultTokenRequestBuilder renewable(boolean renewable)

Configure TTL extension/renewal for the token.

Parameters:

renewable - false to disable the ability of the token to be renewed past its initial TTL. true, or omitting this option, will allow the token to be renewable up to the system/mount maximum TTL.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

ttl

@Deprecated
public VaultTokenRequest.VaultTokenRequestBuilder ttl(long ttl)

Deprecated. since 2.0, use ttl(Duration) for time unit safety.

Configure a TTL (seconds) for the token.

Parameters:

ttl - the time to live in seconds, must not be negative.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

ttl

public VaultTokenRequest.VaultTokenRequestBuilder ttl(long ttl,
                                                      TimeUnit timeUnit)

Configure a TTL (seconds) for the token.

Parameters:

ttl - the time to live, must not be negative.

timeUnit - the time to live time unit, must not be null.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

ttl

public VaultTokenRequest.VaultTokenRequestBuilder ttl(Duration ttl)

Configure a TTL for the token using ChronoUnit.SECONDS resolution.

Parameters:

ttl - the time to live, must not be null or negative.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

Since:

2.0

explicitMaxTtl

@Deprecated
public VaultTokenRequest.VaultTokenRequestBuilder explicitMaxTtl(long explicitMaxTtl)

Deprecated. since 2.0, use explicitMaxTtl(Duration) for time unit safety.

Configure the explicit maximum TTL (seconds) for the token. This maximum token TTL cannot be changed later, and unlike with normal tokens, updates to the system/mount max TTL value will have no effect at renewal time - the token will never be able to be renewed or used past the value set at issue time.

Parameters:

explicitMaxTtl - the time to live in seconds, must not be negative.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

explicitMaxTtl

public VaultTokenRequest.VaultTokenRequestBuilder explicitMaxTtl(long explicitMaxTtl,
                                                                 TimeUnit timeUnit)

Configure the explicit maximum TTL for the token. This maximum token TTL cannot be changed later, and unlike with normal tokens, updates to the system/mount max TTL value will have no effect at renewal time - the token will never be able to be renewed or used past the value set at issue time.

Parameters:

explicitMaxTtl - the time to live, must not be negative.

timeUnit - the time to live, must not be null.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

explicitMaxTtl

public VaultTokenRequest.VaultTokenRequestBuilder explicitMaxTtl(Duration explicitMaxTtl)

Configure the explicit maximum TTL for the token. This maximum token TTL cannot be changed later, and unlike with normal tokens, updates to the system/mount max TTL value will have no effect at renewal time - the token will never be able to be renewed or used past the value set at issue time.

Parameters:

explicitMaxTtl - the time to live, must not be null or negative.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

Since:

2.0

numUses

public VaultTokenRequest.VaultTokenRequestBuilder numUses(int numUses)

Configure the maximum uses for the token. This can be used to create a one-time-token or limited use token. Defaults to 0, which has no limit to the number of uses.

Parameters:

numUses - number of uses, must not be negative.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

displayName

public VaultTokenRequest.VaultTokenRequestBuilder displayName(String displayName)

Configure a display name for the token, defaults to "token".

Parameters:

displayName - must not be empty or null.

Returns:

this VaultTokenRequest.VaultTokenRequestBuilder.

build

public VaultTokenRequest build()

Build a new VaultTokenRequest instance.

Returns:

a new VaultCertificateRequest.