com.northconcepts.datapipeline.security

Class CachingCredentialsResolver

java.lang.Object

com.northconcepts.datapipeline.security.CachingCredentialsResolver

All Implemented Interfaces:

CredentialsResolver

public class CachingCredentialsResolver
extends Object
implements CredentialsResolver

A CredentialsResolver decorator that caches its delegate's credentials, re-fetching when:

• the cached credentials report expiry within getExpirySkewMilliseconds() (see Credentials.isExpired(long)),
• the optional time-to-live has elapsed, or
• refresh() is called.

Gives rotation with backpressure — remote secret stores are only called when needed.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_EXPIRY_SKEW_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
CachingCredentialsResolver(CredentialsResolver resolver) Caches the delegate's credentials until they expire or refresh() is called.
CachingCredentialsResolver(CredentialsResolver resolver, long timeToLiveMilliseconds) Caches the delegate's credentials for at most timeToLiveMilliseconds (zero for no time-to-live).

Method Summary

Modifier and Type	Method and Description
Credentials	getCredentials() Resolves and returns the current credentials.
long	getExpirySkewMilliseconds()
long	getTimeToLiveMilliseconds()
boolean	isRotating() Indicates if this resolver can return different credentials over time.
void	refresh() Forces a re-fetch on the next call to CredentialsResolver.getCredentials().
CachingCredentialsResolver	setExpirySkewMilliseconds(long expirySkewMilliseconds) Sets how long before the credentials' reported expiry they are considered stale.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPIRY_SKEW_MILLISECONDS

public static final long DEFAULT_EXPIRY_SKEW_MILLISECONDS

See Also:

Constant Field Values

Constructor Detail

CachingCredentialsResolver

public CachingCredentialsResolver(CredentialsResolver resolver)

Caches the delegate's credentials until they expire or refresh() is called.

CachingCredentialsResolver

public CachingCredentialsResolver(CredentialsResolver resolver,
                                  long timeToLiveMilliseconds)

Caches the delegate's credentials for at most timeToLiveMilliseconds (zero for no time-to-live).

Method Detail

getTimeToLiveMilliseconds

public long getTimeToLiveMilliseconds()

getExpirySkewMilliseconds

public long getExpirySkewMilliseconds()

setExpirySkewMilliseconds

public CachingCredentialsResolver setExpirySkewMilliseconds(long expirySkewMilliseconds)

Sets how long before the credentials' reported expiry they are considered stale. Defaults to DEFAULT_EXPIRY_SKEW_MILLISECONDS.

getCredentials

public Credentials getCredentials()

Description copied from interface: CredentialsResolver

Resolves and returns the current credentials. Must not return null.

Specified by:

getCredentials in interface CredentialsResolver

refresh

public void refresh()

Description copied from interface: CredentialsResolver

Forces a re-fetch on the next call to CredentialsResolver.getCredentials(). The default implementation does nothing.

Specified by:

refresh in interface CredentialsResolver

isRotating

public boolean isRotating()

Description copied from interface: CredentialsResolver

Indicates if this resolver can return different credentials over time. The default implementation returns false.

Specified by:

isRotating in interface CredentialsResolver

toString

public String toString()

Overrides:

toString in class Object