org.springframework.vault.authentication

Class LoginToken

java.lang.Object

org.springframework.vault.support.VaultToken

org.springframework.vault.authentication.LoginToken

public class LoginToken
extends VaultToken

Value object for a Vault token obtained by a login method.

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoginToken.LoginTokenBuilder Builder for LoginToken.

Method Summary

Modifier and Type	Method and Description
static LoginToken.LoginTokenBuilder	builder()
String	getAccessor()
Duration	getLeaseDuration()
String	getType()
boolean	isBatchToken()
boolean	isRenewable()
boolean	isServiceToken()
static LoginToken	of(char[] token) Create a new LoginToken.
static LoginToken	of(char[] token, Duration leaseDuration) Create a new LoginToken with a leaseDurationSeconds.
static LoginToken	of(char[] token, long leaseDurationSeconds) Deprecated. since 2.0, use of(char[], Duration) for time unit safety.
static LoginToken	of(String token) Create a new LoginToken.
static LoginToken	of(String token, long leaseDurationSeconds) Deprecated. since 2.0, use of(char[], Duration) for time unit safety.
static LoginToken	renewable(char[] token, Duration leaseDuration) Create a new renewable LoginToken with a leaseDurationSeconds.
static LoginToken	renewable(char[] token, long leaseDurationSeconds) Deprecated. since 2.0, use renewable(char[], Duration) for time unit safety.
static LoginToken	renewable(String token, long leaseDurationSeconds) Deprecated. since 2.0, use renewable(char[], Duration) for time unit safety.
static LoginToken	renewable(VaultToken token, Duration leaseDuration) Create a new renewable LoginToken with a leaseDurationSeconds.
String	toString()

Methods inherited from class org.springframework.vault.support.VaultToken

equals, getToken, hashCode, toCharArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static LoginToken.LoginTokenBuilder builder()

Returns:

a new LoginToken.LoginTokenBuilder.

Since:

2.3.3

of

public static LoginToken of(String token)

Create a new LoginToken.

Parameters:

token - must not be null.

Returns:

the created VaultToken

of

public static LoginToken of(char[] token)

Create a new LoginToken.

Parameters:

token - must not be null.

Returns:

the created VaultToken

Since:

1.1

of

@Deprecated
public static LoginToken of(String token,
                                        long leaseDurationSeconds)

Deprecated. since 2.0, use of(char[], Duration) for time unit safety.

Create a new LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds, must not be negative.

Returns:

the created VaultToken

of

@Deprecated
public static LoginToken of(char[] token,
                                        long leaseDurationSeconds)

Deprecated. since 2.0, use of(char[], Duration) for time unit safety.

Create a new LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds, must not be negative.

Returns:

the created VaultToken

Since:

1.1

of

public static LoginToken of(char[] token,
                            Duration leaseDuration)

Create a new LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDuration - the lease duration, must not be negative and not be null.

Returns:

the created VaultToken

Since:

2.0

renewable

@Deprecated
public static LoginToken renewable(String token,
                                               long leaseDurationSeconds)

Deprecated. since 2.0, use renewable(char[], Duration) for time unit safety.

Create a new renewable LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds, must not be negative.

Returns:

the created VaultToken

renewable

@Deprecated
public static LoginToken renewable(char[] token,
                                               long leaseDurationSeconds)

Deprecated. since 2.0, use renewable(char[], Duration) for time unit safety.

Create a new renewable LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds, must not be negative.

Returns:

the created VaultToken

Since:

2.0

renewable

public static LoginToken renewable(VaultToken token,
                                   Duration leaseDuration)

Create a new renewable LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDuration - the lease duration, must not be null or negative.

Returns:

the created VaultToken

Since:

2.0

renewable

public static LoginToken renewable(char[] token,
                                   Duration leaseDuration)

Create a new renewable LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDuration - the lease duration, must not be null or negative.

Returns:

the created VaultToken

Since:

2.0

getLeaseDuration

public Duration getLeaseDuration()

Returns:

the lease duration in seconds. May be 0 if none.

isRenewable

public boolean isRenewable()

Returns:

true if this token is renewable; false otherwise.

getAccessor

@Nullable
public String getAccessor()

Returns:

the token accessor.

Since:

2.3.3

getType

@Nullable
public String getType()

Returns:

the token type.

Since:

2.3.3

See Also:

isBatchToken(), #isServiceToken())

isBatchToken

public boolean isBatchToken()

Returns:

true if the token is a batch token.

Since:

2.3.3

isServiceToken

public boolean isServiceToken()

Returns:

true if the token is a service token.

Since:

2.3.3

toString

public String toString()

Overrides:

toString in class VaultToken