com.erudika.para.rest

Class Signer

java.lang.Object

com.amazonaws.auth.AbstractAWSSigner

com.amazonaws.auth.AWS4Signer

com.erudika.para.rest.Signer

All Implemented Interfaces:

com.amazonaws.auth.EndpointPrefixAwareSigner, com.amazonaws.auth.Presigner, com.amazonaws.auth.RegionAwareSigner, com.amazonaws.auth.ServiceAwareSigner, com.amazonaws.auth.Signer

public final class Signer
extends com.amazonaws.auth.AWS4Signer

This class extends AWS4Signer implementing the AWS Signature Version 4 algorithm. Also contains a method for signature validation. The signatures that this class produces are compatible with the original AWS SDK implementation.

Author:

Alex Bogdanovski [alex@erudika.com]

Field Summary

Fields inherited from class com.amazonaws.auth.AbstractAWSSigner

EMPTY_STRING_SHA256_HEX

Constructor Summary

Constructors

Constructor and Description
Signer() No-args constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	invokeSignedRequest(javax.ws.rs.client.Client apiClient, String accessKey, String secretKey, String httpMethod, String endpointURL, String reqPath, Map<String,String> headers, javax.ws.rs.core.MultivaluedMap<String,String> params, byte[] jsonEntity) Builds, signs and executes a request to an API endpoint using the provided credentials.
javax.ws.rs.core.Response	invokeSignedRequest(javax.ws.rs.client.Client apiClient, String accessKey, String secretKey, String httpMethod, String endpointURL, String reqPath, Map<String,String> headers, javax.ws.rs.core.MultivaluedMap<String,String> params, javax.ws.rs.client.Entity<?> entity) Builds, signs and executes a request to an API endpoint using the provided credentials.
static Date	parseAWSDate(String date) Returns a parsed Date.
void	sign(com.amazonaws.Request<?> request, String accessKey, String secretKey) Signs a request using AWS signature V4.
Map<String,String>	sign(String httpeMethod, String endpoint, String resourcePath, Map<String,String> headers, Map<String,String> params, InputStream entity, String accessKey, String secretKey) Signs a request using AWS signature V4.
Map<String,String>	signRequest(String accessKey, String secretKey, String httpMethod, String endpointURL, String reqPath, Map<String,String> headers, javax.ws.rs.core.MultivaluedMap<String,String> params, byte[] jsonEntity) Builds and signs a request to an API endpoint using the provided credentials.

Methods inherited from class com.amazonaws.auth.AWS4Signer

getOverriddenDate, getRegionName, getServiceName, presignRequest, setEndpointPrefix, setOverrideDate, setRegionName, setServiceName, sign

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

Signer

public Signer()

No-args constructor.

Method Detail

sign

public Map<String,String> sign(String httpeMethod,
                               String endpoint,
                               String resourcePath,
                               Map<String,String> headers,
                               Map<String,String> params,
                               InputStream entity,
                               String accessKey,
                               String secretKey)

Signs a request using AWS signature V4.

Parameters:

httpeMethod - GET/POST/PUT... etc.

endpoint - the hostname of the API server

resourcePath - the path of the resource (starting from root e.g. "/path/to/res")

headers - the headers map

params - the params map

entity - the entity object or null

accessKey - the app's access key

secretKey - the app's secret key

Returns:

a signed request. The actual signature is inside the Authorization header.

sign

public void sign(com.amazonaws.Request<?> request,
                 String accessKey,
                 String secretKey)

Signs a request using AWS signature V4.

Parameters:

request - the request instance

accessKey - the app's access key

secretKey - the app's secret key

parseAWSDate

public static Date parseAWSDate(String date)

Returns a parsed Date.

Parameters:

date - a date in the AWS format yyyyMMdd'T'HHmmss'Z'

Returns:

a date

invokeSignedRequest

public javax.ws.rs.core.Response invokeSignedRequest(javax.ws.rs.client.Client apiClient,
                                                     String accessKey,
                                                     String secretKey,
                                                     String httpMethod,
                                                     String endpointURL,
                                                     String reqPath,
                                                     Map<String,String> headers,
                                                     javax.ws.rs.core.MultivaluedMap<String,String> params,
                                                     javax.ws.rs.client.Entity<?> entity)

Builds, signs and executes a request to an API endpoint using the provided credentials. Signs the request using the Amazon Signature 4 algorithm and returns the response.

Parameters:

apiClient - Jersey Client object

accessKey - access key

secretKey - secret key

httpMethod - the method (GET, POST...)

endpointURL - protocol://host:port

reqPath - the API resource path relative to the endpointURL

headers - headers map

params - parameters map

entity - an entity containing any Java object (payload), could be null

Returns:

a response object

invokeSignedRequest

public javax.ws.rs.core.Response invokeSignedRequest(javax.ws.rs.client.Client apiClient,
                                                     String accessKey,
                                                     String secretKey,
                                                     String httpMethod,
                                                     String endpointURL,
                                                     String reqPath,
                                                     Map<String,String> headers,
                                                     javax.ws.rs.core.MultivaluedMap<String,String> params,
                                                     byte[] jsonEntity)

Builds, signs and executes a request to an API endpoint using the provided credentials. Signs the request using the Amazon Signature 4 algorithm and returns the response.

Parameters:

apiClient - Jersey Client object

accessKey - access key

secretKey - secret key

httpMethod - the method (GET, POST...)

endpointURL - protocol://host:port

reqPath - the API resource path relative to the endpointURL

headers - headers map

params - parameters map

jsonEntity - an object serialized to JSON byte array (payload), could be null

Returns:

a response object

signRequest

public Map<String,String> signRequest(String accessKey,
                                      String secretKey,
                                      String httpMethod,
                                      String endpointURL,
                                      String reqPath,
                                      Map<String,String> headers,
                                      javax.ws.rs.core.MultivaluedMap<String,String> params,
                                      byte[] jsonEntity)

Builds and signs a request to an API endpoint using the provided credentials.

Parameters:

accessKey - access key

secretKey - secret key

httpMethod - the method (GET, POST...)

endpointURL - protocol://host:port

reqPath - the API resource path relative to the endpointURL

headers - headers map

params - parameters map

jsonEntity - an object serialized to JSON byte array (payload), could be null

Returns:

a map containing the "Authorization" header