org.springframework.vault.authentication

Class LifecycleAwareSessionManager

java.lang.Object

org.springframework.vault.authentication.LifecycleAwareSessionManager

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, SessionManager

public class LifecycleAwareSessionManager
extends Object
implements SessionManager, org.springframework.beans.factory.DisposableBean

Lifecycle-aware Session Manager. This SessionManager obtains tokens from a ClientAuthentication upon request. Tokens are renewed asynchronously if a token has a lease duration. This happens 5 seconds before the token expires, see REFRESH_PERIOD_BEFORE_EXPIRY.

This SessionManager also implements DisposableBean to revoke the LoginToken once it's not required anymore. Token revocation will stop regular token refresh.

If Token renewal runs into a client-side error, it assumes the token was revoked/expired and discards the token state so the next attempt will lead to another login attempt.

Author:

Mark Paluch, Steven Swor

See Also:

LoginToken, SessionManager, AsyncTaskExecutor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LifecycleAwareSessionManager.FixedTimeoutRefreshTrigger LifecycleAwareSessionManager.RefreshTrigger implementation using a fixed timeout to schedule renewal before a LoginToken expires.
static interface	LifecycleAwareSessionManager.RefreshTrigger Common interface for trigger objects that determine the next execution time of a refresh task that they get associated with.

Field Summary

Fields

Modifier and Type	Field and Description
static int	REFRESH_PERIOD_BEFORE_EXPIRY Refresh 5 seconds before the token expires.

Constructor Summary

Constructors

Constructor and Description
LifecycleAwareSessionManager(ClientAuthentication clientAuthentication, org.springframework.scheduling.TaskScheduler taskScheduler, org.springframework.web.client.RestOperations restOperations) Create a LifecycleAwareSessionManager given ClientAuthentication, AsyncTaskExecutor and RestOperations.
LifecycleAwareSessionManager(ClientAuthentication clientAuthentication, org.springframework.scheduling.TaskScheduler taskScheduler, org.springframework.web.client.RestOperations restOperations, LifecycleAwareSessionManager.RefreshTrigger refreshTrigger) Create a LifecycleAwareSessionManager given ClientAuthentication, AsyncTaskExecutor and RestOperations.

Method Summary

Modifier and Type	Method and Description
void	destroy()
VaultToken	getSessionToken() Obtain a session token.
protected boolean	isTokenRenewable()
protected VaultToken	login()
protected boolean	renewToken() Performs a token refresh.

Methods inherited from class java.lang.Object

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

Field Detail

REFRESH_PERIOD_BEFORE_EXPIRY

public static final int REFRESH_PERIOD_BEFORE_EXPIRY

Refresh 5 seconds before the token expires.

See Also:

Constant Field Values

Constructor Detail

LifecycleAwareSessionManager

public LifecycleAwareSessionManager(ClientAuthentication clientAuthentication,
                                    org.springframework.scheduling.TaskScheduler taskScheduler,
                                    org.springframework.web.client.RestOperations restOperations)

Create a LifecycleAwareSessionManager given ClientAuthentication, AsyncTaskExecutor and RestOperations.

Parameters:

clientAuthentication - must not be null.

taskScheduler - must not be null.

restOperations - must not be null.

LifecycleAwareSessionManager

public LifecycleAwareSessionManager(ClientAuthentication clientAuthentication,
                                    org.springframework.scheduling.TaskScheduler taskScheduler,
                                    org.springframework.web.client.RestOperations restOperations,
                                    LifecycleAwareSessionManager.RefreshTrigger refreshTrigger)

Create a LifecycleAwareSessionManager given ClientAuthentication, AsyncTaskExecutor and RestOperations.

Parameters:

clientAuthentication - must not be null.

taskScheduler - must not be null.

restOperations - must not be null.

refreshTrigger - must not be null.

Since:

1.0.1

Method Detail

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

renewToken

protected boolean renewToken()

Performs a token refresh. Create a new token if no token was obtained before. If a token was obtained before, it uses self-renewal to renew the current token. Client-side errors (like permission denied) indicate the token cannot be renewed because it's expired or simply not found.

Returns:

true if the refresh was successful. false if a new token was obtained or refresh failed.

getSessionToken

public VaultToken getSessionToken()

Description copied from interface: SessionManager

Obtain a session token.

Specified by:

getSessionToken in interface SessionManager

Returns:

a session token.

login

protected VaultToken login()

isTokenRenewable

protected boolean isTokenRenewable()