software.amazon.awssdk.auth.signer

Class Aws4Signer

java.lang.Object

software.amazon.awssdk.auth.signer.AbstractAwsSigner

software.amazon.awssdk.auth.signer.Aws4Signer

All Implemented Interfaces:

Presigner, RegionAwareSigner, ServiceAwareSigner, Signer

Direct Known Subclasses:

AwsS3V4Signer

public class Aws4Signer
extends AbstractAwsSigner
implements ServiceAwareSigner, RegionAwareSigner, Presigner

Signer implementation that signs requests with the AWS4 signing protocol.

Field Summary

Fields inherited from class software.amazon.awssdk.auth.signer.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
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.
SdkHttpFullRequest	presign(Context.BeforeTransmission execution, ExecutionAttributes executionAttributes, Date userSpecifiedExpirationDate) Signs the request by adding the signature to the URL rather than as a header.
void	setOverrideDate(Date overriddenDate) Sets the date that overrides the signing date in the request.
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.
SdkHttpFullRequest	sign(Context.BeforeTransmission execution, ExecutionAttributes executionAttributes) Sign the given request with the given set of credentials.

Methods inherited from class software.amazon.awssdk.auth.signer.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

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.

getRegionName

public String getRegionName()

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

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.

getServiceName

public String getServiceName()

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

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.

sign

public SdkHttpFullRequest sign(Context.BeforeTransmission execution,
                               ExecutionAttributes executionAttributes)

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:

execution - The immutable state of the execution right before transmission, including the request to sign.

executionAttributes - Additional mutable attributes attached to the execution.

Returns:

The signed request.

presign

public SdkHttpFullRequest presign(Context.BeforeTransmission execution,
                                  ExecutionAttributes executionAttributes,
                                  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:

presign in interface Presigner