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

Method Summary

Modifier and Type	Method and Description
long	getLeaseDuration()
boolean	isRenewable()
static LoginToken	of(char[] token) Create a new LoginToken.
static LoginToken	of(char[] token, long leaseDurationSeconds) Create a new LoginToken with a leaseDurationSeconds.
static LoginToken	of(String token) Create a new LoginToken.
static LoginToken	of(String token, long leaseDurationSeconds) Create a new LoginToken with a leaseDurationSeconds.
static LoginToken	renewable(char[] token, long leaseDurationSeconds) Create a new renewable LoginToken with a leaseDurationSeconds.
static LoginToken	renewable(String token, long leaseDurationSeconds) Create a new renewable LoginToken with a leaseDurationSeconds.

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

getToken, toCharArray

Methods inherited from class java.lang.Object

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

Method Detail

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

public static LoginToken of(String token,
                            long leaseDurationSeconds)

Create a new LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds.

Returns:

the created VaultToken

of

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

Create a new LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds.

Returns:

the created VaultToken

Since:

1.1

renewable

public static LoginToken renewable(String token,
                                   long leaseDurationSeconds)

Create a new renewable LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds.

Returns:

the created VaultToken

renewable

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

Create a new renewable LoginToken with a leaseDurationSeconds.

Parameters:

token - must not be null.

leaseDurationSeconds - the lease duration in seconds.

Returns:

the created VaultToken

Since:

1.1

getLeaseDuration

public long 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.