com.ibm.cloud.objectstorage.auth.json

Class JsonCredentialsProvider

java.lang.Object

com.ibm.cloud.objectstorage.auth.json.JsonCredentialsProvider

All Implemented Interfaces:

AWSCredentialsProvider

public class JsonCredentialsProvider
extends Object
implements AWSCredentialsProvider

Credentials provider based on IBM json configuration. This provider reads IBMCredentials from the json configuration file.

See Also:

JsonConfigFile

Constructor Summary

Constructors

Constructor and Description
JsonCredentialsProvider() Creates a new json credentials provider that returns the IBM security credentials.
JsonCredentialsProvider(JsonConfigFile jsonConfigFile) Creates a new json credentials provider that returns the IBM security credentials.
JsonCredentialsProvider(String jsonConfigFilePath) Creates a new json credentials provider that returns the IBM security credentials.

Method Summary

Modifier and Type	Method and Description
AWSCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
long	getRefreshForceIntervalNanos() Gets the forced refresh interval in nanoseconds.
long	getRefreshIntervalNanos() Gets the refresh interval in nanoseconds.
void	refresh() Forces this credentials provider to refresh its credentials.
void	setRefreshForceIntervalNanos(long refreshForceIntervalNanos) Sets the forced refresh interval in nanoseconds.
void	setRefreshIntervalNanos(long refreshIntervalNanos) Sets the refresh interval in nanoseconds.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonCredentialsProvider

public JsonCredentialsProvider()

Creates a new json credentials provider that returns the IBM security credentials. Loading the credential file is deferred until the getCredentials() method is called.

JsonCredentialsProvider

public JsonCredentialsProvider(String jsonConfigFilePath)

Creates a new json credentials provider that returns the IBM security credentials.

Parameters:

jsonConfigFilePath - The file path where the json configuration file is located.

JsonCredentialsProvider

public JsonCredentialsProvider(JsonConfigFile jsonConfigFile)

Creates a new json credentials provider that returns the IBM security credentials.

Parameters:

jsonConfigFile - The json configuration file containing the credentials used by this credentials provider or null to defer load to first use.

Method Detail

getCredentials

public AWSCredentials getCredentials()

Description copied from interface: AWSCredentialsProvider

Returns AWSCredentials which the caller can use to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.

Specified by:

getCredentials in interface AWSCredentialsProvider

Returns:

AWSCredentials which the caller can use to authorize an AWS request.

refresh

public void refresh()

Description copied from interface: AWSCredentialsProvider

Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.

Specified by:

refresh in interface AWSCredentialsProvider

getRefreshIntervalNanos

public long getRefreshIntervalNanos()

Gets the refresh interval in nanoseconds.

Returns:

nanoseconds

setRefreshIntervalNanos

public void setRefreshIntervalNanos(long refreshIntervalNanos)

Sets the refresh interval in nanoseconds.

Parameters:

refreshIntervalNanos - nanoseconds

getRefreshForceIntervalNanos

public long getRefreshForceIntervalNanos()

Gets the forced refresh interval in nanoseconds.

Returns:

nanoseconds

setRefreshForceIntervalNanos

public void setRefreshForceIntervalNanos(long refreshForceIntervalNanos)

Sets the forced refresh interval in nanoseconds.

toString

public String toString()

Overrides:

toString in class Object