com.ibm.cloud.objectstorage.auth

Class PropertiesCredentials

java.lang.Object

com.ibm.cloud.objectstorage.auth.PropertiesCredentials

All Implemented Interfaces:

AWSCredentials, IBMOAuthCredentials

public class PropertiesCredentials
extends Object
implements IBMOAuthCredentials

Simple implementation AWSCredentials that reads in AWS access keys from a properties file. The AWS access key is expected to be in the "accessKey" property and the AWS secret key id is expected to be in the "secretKey" property.

Constructor Summary

Constructors

Constructor and Description
PropertiesCredentials(File file) Reads the specified file as a Java properties file and extracts the AWS access key from the "accessKey" property and AWS secret access key from the "secretKey" property.
PropertiesCredentials(InputStream inputStream) Reads the specified input stream as a stream of Java properties file content and extracts the AWS access key ID and secret access key from the properties.

Method Summary

Modifier and Type	Method and Description
String	getApiKey() Returns the IBM API Key for this credentials object.
String	getAWSAccessKeyId() Returns the AWS access key ID for this credentials object.
String	getAWSSecretKey() Returns the AWS secret access key for this credentials object.
String	getServiceInstanceId() Returns the IBM Service Instance Id for this credentials object.
TokenManager	getTokenManager() Returns the IAM TokenManager.
void	setTokenManager(TokenManager tokenManager) allows the token manager to be set outside this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesCredentials

public PropertiesCredentials(File file)
                      throws FileNotFoundException,
                             IOException,
                             IllegalArgumentException

Reads the specified file as a Java properties file and extracts the AWS access key from the "accessKey" property and AWS secret access key from the "secretKey" property. If the specified file doesn't contain the AWS access keys an IOException will be thrown.

Parameters:

file - The file from which to read the AWS credentials properties.

Throws:

FileNotFoundException - If the specified file isn't found.

IOException - If any problems are encountered reading the AWS access keys from the specified file.

IllegalArgumentException - If the specified properties file does not contain the required keys.

PropertiesCredentials

public PropertiesCredentials(InputStream inputStream)
                      throws IOException

Reads the specified input stream as a stream of Java properties file content and extracts the AWS access key ID and secret access key from the properties.

Parameters:

inputStream - The input stream containing the AWS credential properties.

Throws:

IOException - If any problems occur while reading from the input stream.

Method Detail

getAWSAccessKeyId

public String getAWSAccessKeyId()

Description copied from interface: AWSCredentials

Returns the AWS access key ID for this credentials object.

Specified by:

getAWSAccessKeyId in interface AWSCredentials

Returns:

The AWS access key ID for this credentials object.

getAWSSecretKey

public String getAWSSecretKey()

Description copied from interface: AWSCredentials

Returns the AWS secret access key for this credentials object.

Specified by:

getAWSSecretKey in interface AWSCredentials

Returns:

The AWS secret access key for this credentials object.

getApiKey

public String getApiKey()

Description copied from interface: IBMOAuthCredentials

Returns the IBM API Key for this credentials object.

Specified by:

getApiKey in interface IBMOAuthCredentials

Returns:

String The IBM API Key for this credentials object.

getServiceInstanceId

public String getServiceInstanceId()

Description copied from interface: IBMOAuthCredentials

Returns the IBM Service Instance Id for this credentials object.

Specified by:

getServiceInstanceId in interface IBMOAuthCredentials

Returns:

String The IBM Service Instance Id for this credentials object.

getTokenManager

public TokenManager getTokenManager()

Description copied from interface: IBMOAuthCredentials

Returns the IAM TokenManager.

Specified by:

getTokenManager in interface IBMOAuthCredentials

Returns:

token The TokenManager implementation

setTokenManager

public void setTokenManager(TokenManager tokenManager)

allows the token manager to be set outside this class. PropertiesFileCredentialsProvider creates a new instance of PropertiesCredentials each time getCredentials are called. This created a new instance of TokenManager also. setter needed to ensure one instance of token manager per s3client.