org.springframework.vault.authentication

Class LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger

java.lang.Object

org.springframework.vault.authentication.LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger

All Implemented Interfaces:

LifecycleAwareSessionManagerSupport.RefreshTrigger

Enclosing class:

LifecycleAwareSessionManagerSupport

public static class LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger
extends Object
implements LifecycleAwareSessionManagerSupport.RefreshTrigger

LifecycleAwareSessionManagerSupport.RefreshTrigger implementation using a fixed timeout to schedule renewal before a LoginToken expires.

Since:

1.0.1

Author:

Mark Paluch

Constructor Summary

Constructors

Constructor and Description
FixedTimeoutRefreshTrigger(Duration refreshBeforeExpiry) Create a new LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger to calculate execution times of refreshBeforeExpiry before the LoginToken expires.
FixedTimeoutRefreshTrigger(Duration refreshBeforeExpiry, Duration expiryThreshold) Create a new LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger to calculate execution times of timeout before the LoginToken expires.
FixedTimeoutRefreshTrigger(long refreshBeforeExpiry, TimeUnit timeUnit) Create a new LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger to calculate execution times of timeout before the LoginToken expires

Method Summary

Modifier and Type	Method and Description
Duration	getValidTtlThreshold(LoginToken loginToken) Returns the minimum TTL duration to consider a token valid after renewal.
Date	nextExecutionTime(LoginToken loginToken) Determine the next execution time according to the given trigger context.

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedTimeoutRefreshTrigger

public FixedTimeoutRefreshTrigger(long refreshBeforeExpiry,
                                  TimeUnit timeUnit)

Create a new LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger to calculate execution times of timeout before the LoginToken expires

Parameters:

refreshBeforeExpiry - timeout value, non-negative long value that schedules an execution of lease duration - refreshBeforeExpiry.

timeUnit - must not be null.

FixedTimeoutRefreshTrigger

public FixedTimeoutRefreshTrigger(Duration refreshBeforeExpiry)

Create a new LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger to calculate execution times of refreshBeforeExpiry before the LoginToken expires. Valid TTL threshold is set to two seconds longer to compensate for timing issues during scheduling.

Parameters:

refreshBeforeExpiry - timeout value for the trigger that schedules an execution of lease duration - refreshBeforeExpiry.

Since:

2.0

FixedTimeoutRefreshTrigger

public FixedTimeoutRefreshTrigger(Duration refreshBeforeExpiry,
                                  Duration expiryThreshold)

Create a new LifecycleAwareSessionManagerSupport.FixedTimeoutRefreshTrigger to calculate execution times of timeout before the LoginToken expires.

Parameters:

refreshBeforeExpiry - timeout value for the trigger that schedules an execution of lease duration - refreshBeforeExpiry.

expiryThreshold - minimum TTL duration to consider a Token as valid. Tokens with a shorter TTL are considered expired and are not used anymore. Should be greater than Tokens with a shorter TTL are not used anymore. Should be greater than timeout to prevent token expiry.

Since:

2.0

Method Detail

nextExecutionTime

public Date nextExecutionTime(LoginToken loginToken)

Description copied from interface: LifecycleAwareSessionManagerSupport.RefreshTrigger

Determine the next execution time according to the given trigger context.

Specified by:

nextExecutionTime in interface LifecycleAwareSessionManagerSupport.RefreshTrigger

Parameters:

loginToken - login token encapsulating renewability and lease duration.

Returns:

the next execution time as defined by the trigger, or null if the trigger won't fire anymore

getValidTtlThreshold

public Duration getValidTtlThreshold(LoginToken loginToken)

Description copied from interface: LifecycleAwareSessionManagerSupport.RefreshTrigger

Returns the minimum TTL duration to consider a token valid after renewal. Tokens with a shorter TTL are revoked and considered expired.

Specified by:

getValidTtlThreshold in interface LifecycleAwareSessionManagerSupport.RefreshTrigger

Parameters:

loginToken - the login token after renewal.

Returns:

minimum TTL Duration to consider a token valid.