com.amazonaws.services.s3.internal

Class S3Signer

java.lang.Object

com.amazonaws.auth.AbstractAWSSigner

com.amazonaws.services.s3.internal.S3Signer

All Implemented Interfaces:

Signer

public class S3Signer
extends AbstractAWSSigner

Implementation of the Signer interface specific to S3's signing algorithm.

Field Summary

Fields inherited from class com.amazonaws.auth.AbstractAWSSigner

EMPTY_STRING_SHA256_HEX

Constructor Summary

Constructors

Constructor and Description
S3Signer() Create a dummy instance of the S3Signer.
S3Signer(String httpVerb, String resourcePath) Constructs a new S3Signer to sign requests based on the AWS credentials, HTTP method and canonical S3 resource path.
S3Signer(String httpVerb, String resourcePath, Collection<String> additionalQueryParamsToSign) Constructs a new S3Signer to sign requests based on the AWS credentials, HTTP method and canonical S3 resource path.

Method Summary

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

Methods inherited from class com.amazonaws.auth.AbstractAWSSigner

hash, hash, sign, signWithMac

Methods inherited from class java.lang.Object

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

Constructor Detail

S3Signer

public S3Signer()

Create a dummy instance of the S3Signer. This constructor will be invoked by internal config via reflection.

S3Signer

public S3Signer(String httpVerb,
                String resourcePath)

Constructs a new S3Signer to sign requests based on the AWS credentials, HTTP method and canonical S3 resource path.

Parameters:

httpVerb - The HTTP verb (GET, PUT, POST, HEAD, DELETE) the request is using.

resourcePath - The canonical S3 resource path (ex: "/", "//", or "//".

S3Signer

public S3Signer(String httpVerb,
                String resourcePath,
                Collection<String> additionalQueryParamsToSign)

Constructs a new S3Signer to sign requests based on the AWS credentials, HTTP method and canonical S3 resource path.

Parameters:

httpVerb - The HTTP verb (GET, PUT, POST, HEAD, DELETE) the request is using.

resourcePath - The canonical S3 resource path (ex: "/", "//", or "//".

additionalQueryParamsToSign - A collection of user-specified query parameters that should be included in the canonical request, in addition to those default parameters that are always signed.

See Also:

RestUtils#makeS3CanonicalString(String, String, Request, String)

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.