de.stklcode.jvault.connector.model

Class TokenBuilder

java.lang.Object

de.stklcode.jvault.connector.model.TokenBuilder

public final class TokenBuilder
extends Object

A builder for vault tokens.

Since:

0.4.0

Author:

Stefan Kalscheuer

Constructor Summary

Constructors

Constructor and Description
TokenBuilder()

Method Summary

Modifier and Type	Method and Description
TokenBuilder	asOrphan() Create token without parent.
Token	build() Build the token based on given parameters.
TokenBuilder	notRenewable() Set token to be not renewable.
TokenBuilder	renewable() Set token to be renewable.
TokenBuilder	withDefaultPolicy() Attach default policy to token.
TokenBuilder	withDisplayName(String displayName) Add display name.
TokenBuilder	withId(String id) Add token ID.
TokenBuilder	withMeta(Map<String,String> meta) Add meta data.
TokenBuilder	withMeta(String key, String value) Add meta data.
TokenBuilder	withNoDefaultPolicy(boolean noDefaultPolicy) Set TRUE if the default policy should not be part of this token.
TokenBuilder	withNoParent(boolean noParent) Set TRUE if the token should be created without parent.
TokenBuilder	withNumUses(Integer numUses) Set desired number of uses.
TokenBuilder	withoutDefaultPolicy() Do not attach default policy to token.
TokenBuilder	withParent() Create token with parent.
TokenBuilder	withPolicies(List<String> policies) Add given policies.
TokenBuilder	withPolicies(String... policies) Add given policies.
TokenBuilder	withPolicy(String policy) Add a single policy.
TokenBuilder	withRenewable(Boolean renewable) Set if token is renewable.
TokenBuilder	withTtl(Integer ttl) Set desired time to live.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenBuilder

public TokenBuilder()

Method Detail

withId

public TokenBuilder withId(String id)

Add token ID. (optional)

Parameters:

id - the ID

Returns:

self

withDisplayName

public TokenBuilder withDisplayName(String displayName)

Add display name.

Parameters:

displayName - the display name

Returns:

self

withTtl

public TokenBuilder withTtl(Integer ttl)

Set desired time to live.

Parameters:

ttl - the ttl

Returns:

self

withNumUses

public TokenBuilder withNumUses(Integer numUses)

Set desired number of uses.

Parameters:

numUses - the number of uses

Returns:

self

withNoParent

public TokenBuilder withNoParent(boolean noParent)

Set TRUE if the token should be created without parent.

Parameters:

noParent - if TRUE, token is created as orphan

Returns:

self

asOrphan

public TokenBuilder asOrphan()

Create token without parent. Convenience method for withNoParent()

Returns:

self

withParent

public TokenBuilder withParent()

Create token with parent. Convenience method for withNoParent()

Returns:

self

withNoDefaultPolicy

public TokenBuilder withNoDefaultPolicy(boolean noDefaultPolicy)

Set TRUE if the default policy should not be part of this token.

Parameters:

noDefaultPolicy - if TRUE, default policy is not attached

Returns:

self

withDefaultPolicy

public TokenBuilder withDefaultPolicy()

Attach default policy to token. Convenience method for withNoDefaultPolicy()

Returns:

self

withoutDefaultPolicy

public TokenBuilder withoutDefaultPolicy()

Do not attach default policy to token. Convenience method for withNoDefaultPolicy()

Returns:

self

withPolicies

public TokenBuilder withPolicies(String... policies)

Add given policies.

Parameters:

policies - the policies

Returns:

self

Since:

0.5.0

withPolicies

public TokenBuilder withPolicies(List<String> policies)

Add given policies.

Parameters:

policies - the policies

Returns:

self

withPolicy

public TokenBuilder withPolicy(String policy)

Add a single policy.

Parameters:

policy - the policy

Returns:

self

withMeta

public TokenBuilder withMeta(Map<String,String> meta)

Add meta data.

Parameters:

meta - the metadata

Returns:

self

withMeta

public TokenBuilder withMeta(String key,
                             String value)

Add meta data.

Parameters:

key - the key

value - the value

Returns:

self

withRenewable

public TokenBuilder withRenewable(Boolean renewable)

Set if token is renewable.

Parameters:

renewable - TRUE, if renewable

Returns:

self

renewable

public TokenBuilder renewable()

Set token to be renewable. Convenience method for withRenewable()

Returns:

self

notRenewable

public TokenBuilder notRenewable()

Set token to be not renewable. Convenience method for withRenewable()

Returns:

self

build

public Token build()

Build the token based on given parameters.

Returns:

the token