com.ibm.cloud.objectstorage.oauth

Class BasicIBMOAuthCredentials

java.lang.Object

com.ibm.cloud.objectstorage.oauth.BasicIBMOAuthCredentials

All Implemented Interfaces:

AWSCredentials, IBMOAuthCredentials

public class BasicIBMOAuthCredentials
extends Object
implements IBMOAuthCredentials

Basic implementation of the IBMOAuthCredentials interface that allows callers to pass in the IBM api key and service instance id in the constructor.

Constructor Summary

Constructors

Constructor and Description
BasicIBMOAuthCredentials(String apiKey, String serviceInstanceId) Constructs a new BasicIBMOAuthCredentials object, with the specified IBM api key and service instance id.
BasicIBMOAuthCredentials(TokenManager tokenManager) Constructor using a custom TokenManager
BasicIBMOAuthCredentials(TokenManager tokenManager, String serviceInstanceId) Constructor using a custom TokenManager
BasicIBMOAuthCredentials(TokenProvider tokenProvider) Constructor using a custom Token Provider, this implementation will use the DefaultTokenManager as the Token Manager.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicIBMOAuthCredentials

public BasicIBMOAuthCredentials(String apiKey,
                                String serviceInstanceId)

Constructs a new BasicIBMOAuthCredentials object, with the specified IBM api key and service instance id.

Parameters:

apiKey - The API key.

serviceInstanceId - The service instance id.

BasicIBMOAuthCredentials

public BasicIBMOAuthCredentials(TokenManager tokenManager)

Constructor using a custom TokenManager

Parameters:

tokenManager - An instance of Token Manager

BasicIBMOAuthCredentials

public BasicIBMOAuthCredentials(TokenManager tokenManager,
                                String serviceInstanceId)

Constructor using a custom TokenManager

Parameters:

tokenManager - An instance of Token Manager

serviceInstanceId - serviceInstanceId used for create & list buckets requests

BasicIBMOAuthCredentials

public BasicIBMOAuthCredentials(TokenProvider tokenProvider)

Constructor using a custom Token Provider, this implementation will use the DefaultTokenManager as the Token Manager.

Parameters:

tokenProvider - An instance of TokenProvider

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.

getTokenManager

public TokenManager getTokenManager()

Description copied from interface: IBMOAuthCredentials

Returns the IAM TokenManager.

Specified by:

getTokenManager in interface IBMOAuthCredentials

Returns:

token The TokenManager implementation

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.