com.ibm.cos.v2.http.auth.aws.internal.signer

Class DefaultAwsV4HttpSigner

java.lang.Object

com.ibm.cos.v2.http.auth.aws.internal.signer.DefaultAwsV4HttpSigner

All Implemented Interfaces:

AwsV4FamilyHttpSigner<AwsCredentialsIdentity>, AwsV4HttpSigner, HttpSigner<AwsCredentialsIdentity>

public final class DefaultAwsV4HttpSigner
extends Object
implements AwsV4HttpSigner

An implementation of a AwsV4HttpSigner that uses properties to compose v4-signers in order to delegate signing of a request and payload (if applicable) accordingly.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cos.v2.http.auth.aws.signer.AwsV4FamilyHttpSigner

AwsV4FamilyHttpSigner.AuthLocation

Field Summary

Fields inherited from interface com.ibm.cos.v2.http.auth.aws.signer.AwsV4HttpSigner

REGION_NAME

Fields inherited from interface com.ibm.cos.v2.http.auth.aws.signer.AwsV4FamilyHttpSigner

AUTH_LOCATION, CHECKSUM_ALGORITHM, CHUNK_ENCODING_ENABLED, DOUBLE_URL_ENCODE, EXPIRATION_DURATION, IBM_IAM_APIKEY, IBM_IAM_SERVICEINSTANCEID, NORMALIZE_PATH, PAYLOAD_SIGNING_ENABLED, SERVICE_SIGNING_NAME

Fields inherited from interface com.ibm.cos.v2.http.auth.spi.signer.HttpSigner

SIGNING_CLOCK

Constructor Summary

Constructors

Constructor and Description
DefaultAwsV4HttpSigner()

Method Summary

Modifier and Type	Method and Description
SignedRequest	sign(SignRequest<? extends AwsCredentialsIdentity> request) Method that takes in inputs to sign a request with sync payload and returns a signed version of the request.
CompletableFuture<AsyncSignedRequest>	signAsync(AsyncSignRequest<? extends AwsCredentialsIdentity> request) Method that takes in inputs to sign a request with async payload and returns a future containing the signed version of the request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.http.auth.aws.signer.AwsV4HttpSigner

create

Methods inherited from interface com.ibm.cos.v2.http.auth.spi.signer.HttpSigner

doNotSign, sign, signAsync

Constructor Detail

DefaultAwsV4HttpSigner

public DefaultAwsV4HttpSigner()

Method Detail

sign

public SignedRequest sign(SignRequest<? extends AwsCredentialsIdentity> request)

Description copied from interface: HttpSigner

Method that takes in inputs to sign a request with sync payload and returns a signed version of the request.

Specified by:

sign in interface HttpSigner<AwsCredentialsIdentity>

Parameters:

request - The inputs to sign a request.

Returns:

A signed version of the request.

signAsync

public CompletableFuture<AsyncSignedRequest> signAsync(AsyncSignRequest<? extends AwsCredentialsIdentity> request)

Description copied from interface: HttpSigner

Method that takes in inputs to sign a request with async payload and returns a future containing the signed version of the request.

Specified by:

signAsync in interface HttpSigner<AwsCredentialsIdentity>

Parameters:

request - The inputs to sign a request.

Returns:

A future containing the signed version of the request.