org.finra.herd.tools.common.databridge

Class AutoRefreshCredentialProvider

java.lang.Object

org.finra.herd.tools.common.databridge.AutoRefreshCredentialProvider

All Implemented Interfaces:

HerdAWSCredentialsProvider

public abstract class AutoRefreshCredentialProvider
extends Object
implements HerdAWSCredentialsProvider

An abstract AWS credentials provider which automatically refreshes based on the session expiration time.

Constructor Summary

Constructors

Constructor and Description
AutoRefreshCredentialProvider()

Method Summary

Modifier and Type	Method and Description
AwsCredential	getAwsCredential() Retrieves a fresh set of credentials if there is no current cached credentials, or the session has expired.
abstract AwsCredential	getNewAwsCredential() Gets a new set of AWS credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoRefreshCredentialProvider

public AutoRefreshCredentialProvider()

Method Detail

getNewAwsCredential

public abstract AwsCredential getNewAwsCredential()
                                           throws Exception

Gets a new set of AWS credentials.

Returns:

AWS credentials

Throws:

Exception - when any exception occurs

getAwsCredential

public AwsCredential getAwsCredential()

Retrieves a fresh set of credentials if there is no current cached credentials, or the session has expired. Otherwise, returns the cached credentials.

Specified by:

getAwsCredential in interface HerdAWSCredentialsProvider

Returns:

AwsCredential