com.ibm.cloud.objectstorage.auth

Class QueryStringSigner

java.lang.Object

com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

com.ibm.cloud.objectstorage.auth.QueryStringSigner

All Implemented Interfaces:

Signer

public class QueryStringSigner
extends AbstractAWSSigner
implements Signer

Signer implementation responsible for signing an AWS query string request according to the various signature versions and hashing algorithms.

Field Summary

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

EMPTY_STRING_SHA256_HEX

Constructor Summary

Constructors

Constructor and Description
QueryStringSigner()

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) This signer will add "Signature" parameter to the request.
void	sign(SignableRequest<?> request, SignatureVersion version, SigningAlgorithm algorithm, AWSCredentials credentials) This signer will add following authentication parameters to the request: AWSAccessKeyId SignatureVersion SignatureMethod Timestamp Signature

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

Constructor Detail

QueryStringSigner

public QueryStringSigner()

Method Detail

sign

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

This signer will add "Signature" parameter to the request. Default signature version is "2" and default signing algorithm is "HmacSHA256". AWSAccessKeyId SignatureVersion SignatureMethod Timestamp Signature

Specified by:

sign in interface Signer

Parameters:

request - request to be signed.

credentials - The credentials used to use to sign the request.

Throws:

SdkClientException

sign

public void sign(SignableRequest<?> request,
                 SignatureVersion version,
                 SigningAlgorithm algorithm,
                 AWSCredentials credentials)
          throws SdkClientException

This signer will add following authentication parameters to the request: AWSAccessKeyId SignatureVersion SignatureMethod Timestamp Signature

Parameters:

request - request to be signed.

version - signature version. "2" is recommended.

algorithm - signature algorithm. "HmacSHA256" is recommended.

Throws:

SdkClientException

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