com.ibm.cloud.objectstorage.oauth

Class IBMOAuthSigner

java.lang.Object

com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

com.ibm.cloud.objectstorage.oauth.IBMOAuthSigner

All Implemented Interfaces:

Signer

public class IBMOAuthSigner
extends AbstractAWSSigner

Signer implementation that signs requests with the OAuth 2.0 signing protocol. The Bearer token is added to the Authorization header of the request

Field Summary

Fields

Modifier and Type	Field and Description
protected static InternalLogApi	log

Fields inherited from class com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

EMPTY_STRING_SHA256_HEX

Constructor Summary

Constructors

Constructor and Description
IBMOAuthSigner() Default public constructor
IBMOAuthSigner(ClientConfiguration clientConfiguration) Public constructor to accept clientconfiguration parameter, which is then passed through to DefaultTokenManager and used for proxy config on IAM calls for token retrieval

Method Summary

Modifier and Type	Method and Description
protected void	addSessionCredentials(SignableRequest<?> request, AWSSessionCredentials credentials) Adds session credentials to the request given.
void	sign(SignableRequest<?> request, AWSCredentials credentials) Sign the given request with the given set of credentials.

Methods inherited from class com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

getBinaryRequestPayload, getBinaryRequestPayloadStream, getBinaryRequestPayloadStreamWithoutQueryParams, getBinaryRequestPayloadWithoutQueryParams, getCanonicalizedEndpoint, getCanonicalizedQueryString, getCanonicalizedQueryString, getCanonicalizedResourcePath, getCanonicalizedResourcePath, getRequestPayload, getRequestPayloadWithoutQueryParams, getSignatureDate, getTimeOffset, hash, hash, hash, newString, sanitizeCredentials, sign, sign, signAndBase64Encode, signAndBase64Encode, signWithMac

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final InternalLogApi log

Constructor Detail

IBMOAuthSigner

public IBMOAuthSigner(ClientConfiguration clientConfiguration)

Public constructor to accept clientconfiguration parameter, which is then passed through to DefaultTokenManager and used for proxy config on IAM calls for token retrieval

Parameters:

clientConfiguration - This config is used in IAM token retrieval to determine if request should go through a proxy

IBMOAuthSigner

public IBMOAuthSigner()

Default public constructor

Method Detail

sign

public void sign(SignableRequest<?> request,
                 AWSCredentials credentials)

Description copied from interface: Signer

Sign the given request with the given set of credentials. Modifies the passed-in request to apply the signature.

Parameters:

request - The request to sign.

credentials - The credentials to sign the request with.

addSessionCredentials

protected void addSessionCredentials(SignableRequest<?> request,
                                     AWSSessionCredentials credentials)

Description copied from class: AbstractAWSSigner

Adds session credentials to the request given.

Specified by:

addSessionCredentials in class AbstractAWSSigner

Parameters:

request - The request to add session credentials information to

credentials - The session credentials to add to the request