com.ibm.cloud.objectstorage.auth

Class JsonCredentials

java.lang.Object

com.ibm.cloud.objectstorage.auth.JsonCredentials

All Implemented Interfaces:

AWSCredentials, IBMOAuthCredentials

public class JsonCredentials
extends Object
implements IBMOAuthCredentials

Simple implementation of IBMOAuthCredentials that reads in API key and resource instance id from json file. The IBM api key is expected to be in the "apikey" property and the resource instance id is expected to be in the "resource_instance_id" property.

Constructor Summary

Constructors

Constructor and Description
JsonCredentials(File file) Reads the specified file as a Json file and extracts the IBM api key from the "apikey" field and IBM resource instance id from the "resource#_instance_id" filed.
JsonCredentials(InputStream stream) Reads the specified input stream as a stream of json object content and extracts the IBM api key and resource instance id from the object.

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.
boolean	isHmacEnabled()
boolean	isIamEnabled()
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

JsonCredentials

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

Reads the specified file as a Json file and extracts the IBM api key from the "apikey" field and IBM resource instance id from the "resource#_instance_id" filed. If the specified file doesn't contain the IBM api key and resource instance id an IOException will be thrown.

Parameters:

file - The file from which to read the IBM credentials.

Throws:

FileNotFoundException - If the specified file isn't found.

IOException - If any problems are encountered reading the IBM credentials from the specified file.

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

JsonCredentials

public JsonCredentials(InputStream stream)
                throws IOException

Reads the specified input stream as a stream of json object content and extracts the IBM api key and resource instance id from the object.

Parameters:

inputStream - The input stream containing the IBM 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

isHmacEnabled

public boolean isHmacEnabled()

isIamEnabled

public boolean isIamEnabled()

setTokenManager

public void setTokenManager(TokenManager tokenManager)

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