com.ibm.cloud.objectstorage.oauth

Interface IBMOAuthCredentials

All Superinterfaces:

AWSCredentials

All Known Implementing Classes:

BasicIBMOAuthCredentials, JsonCredentials, PropertiesCredentials

public interface IBMOAuthCredentials
extends AWSCredentials

Provides access to the AWS OAuth credentials used for accessing IBM services: IBM api key & service instance id. These credentials are used to securely obtain an access token & sign requests to IBM COS services.

A basic implementation of this interface is provided in BasicIBMOAuthCredentials, but callers are free to provide their own implementation, for example, to load AWS credentials from an encrypted file.

Method Summary

Modifier and Type	Method and Description
String	getApiKey() Returns the IBM API 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 interface com.ibm.cloud.objectstorage.auth.AWSCredentials

getAWSAccessKeyId, getAWSSecretKey

Method Detail

getApiKey

String getApiKey()

Returns the IBM API Key for this credentials object.

Returns:

String The IBM API Key for this credentials object.

getServiceInstanceId

String getServiceInstanceId()

Returns the IBM Service Instance Id for this credentials object.

Returns:

String The IBM Service Instance Id for this credentials object.

getTokenManager

TokenManager getTokenManager()

Returns the IAM TokenManager.

Returns:

token The TokenManager implementation