com.boomi.common.aws

Interface AWSSignableRequest

All Known Implementing Classes:

HttpAWSSignableRequest

public interface AWSSignableRequest

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Add a new header parameter required by the AWS Signature to the request to be sent.
AWSCredentials	getCredentials() Getter method to access the AWSCredential instance when the requet is being signed
Map<String,Object>	getHeaders() Getter method to access the request headers that needs to be included on the signature.
String	getMethod() Getter method to access the request http method
InputStream	getPayload() Getter method to access the request payload on signature generation time
long	getTimeStamp() Getter method to access the request timestamp to generate the signature
String	getUrl() Getter method to access the full request URL
void	sign(String signingKey) This method will be invoked from AWSV4Signer.sign(AWSSignableRequest) to pass back the signing key that needs to be included as the "Authorization" header into the original request.

Method Detail

addHeader

void addHeader(String name,
               String value)

Add a new header parameter required by the AWS Signature to the request to be sent. Any headers added using this method are expected to be returned by subsequent calls to getHeaders().

Parameters:

name - header parameter name required by AWS signature

value - header parameter value

getCredentials

AWSCredentials getCredentials()

Getter method to access the AWSCredential instance when the requet is being signed

Returns:

an AWSCredentials instance with the properties used to form the request

getPayload

InputStream getPayload()
                throws IOException

Getter method to access the request payload on signature generation time

Returns:

an InputStream with the request body payload

Throws:

IOException - if there's a problem while reading the payload

getMethod

String getMethod()

Getter method to access the request http method

Returns:

a String representation of the HTTP method

getUrl

String getUrl()

Getter method to access the full request URL

Returns:

a String representation of the request URL

getHeaders

Map<String,Object> getHeaders()

Getter method to access the request headers that needs to be included on the signature.

Returns:

a Map with the headers included on the request to be signed

sign

void sign(String signingKey)

This method will be invoked from AWSV4Signer.sign(AWSSignableRequest) to pass back the signing key that needs to be included as the "Authorization" header into the original request. While calling addHeader("Authorization", signingKey); should be enough to implement this method for most of http clients, it had to be isolated because some implementations like Restlet requires to use a different mechanism to add these particular headers.

getTimeStamp

long getTimeStamp()

Getter method to access the request timestamp to generate the signature

Returns:

a long value to be used as the signature timestamp