com.amazonaws.auth

Class AWS4Signer

java.lang.Object

com.amazonaws.auth.AbstractAWSSigner

com.amazonaws.auth.AWS4Signer

All Implemented Interfaces:

EndpointPrefixAwareSigner, Presigner, RegionAwareSigner, RegionFromEndpointResolverAwareSigner, ServiceAwareSigner, Signer

Direct Known Subclasses:

AWS4UnsignedPayloadSigner, AWSS3V4Signer, PutMediaAWS4Signer

public class AWS4Signer
extends AbstractAWSSigner
implements ServiceAwareSigner, RegionAwareSigner, Presigner, EndpointPrefixAwareSigner, RegionFromEndpointResolverAwareSigner

Signer implementation that signs requests with the AWS4 signing protocol.

Field Summary

Fields inherited from class com.amazonaws.auth.AbstractAWSSigner

EMPTY_STRING_SHA256_HEX

Constructor Summary

Constructors

Constructor and Description
AWS4Signer() Construct a new AWS4 signer instance.
AWS4Signer(boolean doubleUrlEncoding) Construct a new AWS4 signer instance.
AWS4Signer(SdkClock clock)

Method Summary

Modifier and Type	Method and Description
Date	getOverriddenDate() Returns a copy of date that overrides the signing date in the request.
String	getRegionName() Returns the region name that is used when calculating the signature.
String	getServiceName() Returns the service name that is used when calculating the signature.
void	presignRequest(SignableRequest<?> request, AWSCredentials credentials, Date userSpecifiedExpirationDate) Signs the request by adding the signature to the URL rather than as a header.
void	setEndpointPrefix(String endpointPrefix) Sets the endpoint prefix which is used to compute the region that is used for signing the request.
void	setOverrideDate(Date overriddenDate) Sets the date that overrides the signing date in the request.
void	setRegionFromEndpointResolver(RegionFromEndpointResolver resolver) Set the RegionFromEndpointResolver to use when converting an endpoint into a region.
void	setRegionName(String regionName) Sets the region name that this signer should use when calculating request signatures.
void	setServiceName(String serviceName) Sets the service name that this signer should use when calculating request signatures.
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

AWS4Signer

public AWS4Signer()

Construct a new AWS4 signer instance. By default, enable double url-encoding.

AWS4Signer

public AWS4Signer(boolean doubleUrlEncoding)

Construct a new AWS4 signer instance.

Parameters:

doubleUrlEncoding - Whether double url-encode the resource path when constructing the canonical request.

AWS4Signer

public AWS4Signer(SdkClock clock)

Method Detail

setServiceName

public void setServiceName(String serviceName)

Sets the service name that this signer should use when calculating request signatures. This can almost always be determined directly from the request's end point, so you shouldn't need this method, but it's provided for the edge case where the information is not in the endpoint.

Specified by:

setServiceName in interface ServiceAwareSigner

Parameters:

serviceName - The service name to use when calculating signatures in this signer.

setRegionName

public void setRegionName(String regionName)

Sets the region name that this signer should use when calculating request signatures. This can almost always be determined directly from the request's end point, so you shouldn't need this method, but it's provided for the edge case where the information is not in the endpoint.

Specified by:

setRegionName in interface RegionAwareSigner

Parameters:

regionName - The region name to use when calculating signatures in this signer.

setEndpointPrefix

public void setEndpointPrefix(String endpointPrefix)

Sets the endpoint prefix which is used to compute the region that is used for signing the request. This value is passed to AWS4SignerRequestParams class which has the logic to compute region.

Specified by:

setEndpointPrefix in interface EndpointPrefixAwareSigner

Parameters:

endpointPrefix - The endpoint prefix of the service

setOverrideDate

public void setOverrideDate(Date overriddenDate)

Sets the date that overrides the signing date in the request. This method is internal and should be used only for testing purposes.

setRegionFromEndpointResolver

public void setRegionFromEndpointResolver(RegionFromEndpointResolver resolver)

Description copied from interface: RegionFromEndpointResolverAwareSigner

Set the RegionFromEndpointResolver to use when converting an endpoint into a region.

Specified by:

setRegionFromEndpointResolver in interface RegionFromEndpointResolverAwareSigner

getRegionName

public String getRegionName()

Returns the region name that is used when calculating the signature.

getServiceName

public String getServiceName()

Returns the service name that is used when calculating the signature.

getOverriddenDate

public Date getOverriddenDate()

Returns a copy of date that overrides the signing date in the request. Return null by default.

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.

Specified by:

sign in interface Signer

Parameters:

request - The request to sign.

credentials - The credentials to sign the request with.

presignRequest

public void presignRequest(SignableRequest<?> request,
                           AWSCredentials credentials,
                           Date userSpecifiedExpirationDate)

Description copied from interface: Presigner

Signs the request by adding the signature to the URL rather than as a header. This method is expected to modify the passed-in request to add the signature.

Specified by:

presignRequest in interface Presigner

Parameters:

request - The request to sign.

credentials - The credentials to sign it with.

userSpecifiedExpirationDate - The time when this presigned URL will expire.