com.mdsol.mauth

Class DefaultSigner

java.lang.Object

com.mdsol.mauth.DefaultSigner

All Implemented Interfaces:

Signer

public class DefaultSigner
extends java.lang.Object
implements Signer

Constructor Summary

Constructors

Constructor and Description
DefaultSigner(SignerConfiguration configuration)
DefaultSigner(java.util.UUID appUUID, java.security.PrivateKey privateKey)
DefaultSigner(java.util.UUID appUUID, java.security.PrivateKey privateKey, com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider)
DefaultSigner(java.util.UUID appUUID, java.security.PrivateKey privateKey, com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider, java.util.List<com.mdsol.mauth.MAuthVersion> signVersions)
DefaultSigner(java.util.UUID appUUID, java.lang.String privateKey)
DefaultSigner(java.util.UUID appUUID, java.lang.String privateKey, com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider)
DefaultSigner(java.util.UUID appUUID, java.lang.String privateKey, com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider, java.util.List<com.mdsol.mauth.MAuthVersion> signVersions)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	generateRequestHeaders(java.lang.String httpVerb, java.lang.String requestPath, byte[] requestPayload, java.lang.String queryParameters) Generates the mAuth headers from the provided HTTP request data for Mauth V2(and V1) protocol NOTE: mAuth headers are time sensitive.
java.util.Map<java.lang.String,java.lang.String>	generateRequestHeaders(java.lang.String httpVerb, java.lang.String requestPath, java.io.InputStream requestPayload, java.lang.String queryParameters) Generates the mAuth headers from the provided HTTP request data for Mauth V2 or V1 protocol NOTE: mAuth headers are time sensitive.
java.util.Map<java.lang.String,java.lang.String>	generateRequestHeaders(java.lang.String httpVerb, java.lang.String requestPath, java.lang.String requestPayload) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSigner

public DefaultSigner(SignerConfiguration configuration)

DefaultSigner

public DefaultSigner(java.util.UUID appUUID,
                     java.lang.String privateKey)

DefaultSigner

public DefaultSigner(java.util.UUID appUUID,
                     java.lang.String privateKey,
                     com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider)

DefaultSigner

public DefaultSigner(java.util.UUID appUUID,
                     java.security.PrivateKey privateKey)

DefaultSigner

public DefaultSigner(java.util.UUID appUUID,
                     java.security.PrivateKey privateKey,
                     com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider)

DefaultSigner

public DefaultSigner(java.util.UUID appUUID,
                     java.lang.String privateKey,
                     com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider,
                     java.util.List<com.mdsol.mauth.MAuthVersion> signVersions)

DefaultSigner

public DefaultSigner(java.util.UUID appUUID,
                     java.security.PrivateKey privateKey,
                     com.mdsol.mauth.util.EpochTimeProvider epochTimeProvider,
                     java.util.List<com.mdsol.mauth.MAuthVersion> signVersions)

Method Detail

generateRequestHeaders

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> generateRequestHeaders(java.lang.String httpVerb,
                                                                                           java.lang.String requestPath,
                                                                                           java.lang.String requestPayload)
                                                                                    throws com.mdsol.mauth.exceptions.MAuthSigningException

Deprecated.

Description copied from interface: Signer

Generates the mAuth headers from the provided HTTP request data for Mauth V1. NOTE: mAuth headers are time sensitive. The headers must be verified by the receiving service within 5 minutes of being generated otherwise the request will fail.

Specified by:

generateRequestHeaders in interface Signer

Parameters:

httpVerb - The HTTP verb of the request, e.g. GET, POST, etc.

requestPath - The path of the request, not including protocol, host or query parameters.

requestPayload - The payload of the request

Returns:

MAuth headers which should be appended to the request before sending.

Throws:

com.mdsol.mauth.exceptions.MAuthSigningException - when request cannot be signed

generateRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> generateRequestHeaders(java.lang.String httpVerb,
                                                                               java.lang.String requestPath,
                                                                               byte[] requestPayload,
                                                                               java.lang.String queryParameters)
                                                                        throws com.mdsol.mauth.exceptions.MAuthSigningException

Description copied from interface: Signer

Generates the mAuth headers from the provided HTTP request data for Mauth V2(and V1) protocol NOTE: mAuth headers are time sensitive. The headers must be verified by the receiving service within 5 minutes of being generated otherwise the request will fail.

Specified by:

generateRequestHeaders in interface Signer

Parameters:

httpVerb - The HTTP verb of the request, e.g. GET, POST, etc.

requestPath - The path of the request, not including protocol, host or query parameters.

requestPayload - The payload of the request

queryParameters - The query parameters (URL-encoded)

Returns:

MAuth headers which should be appended to the request before sending.

Throws:

com.mdsol.mauth.exceptions.MAuthSigningException - when request cannot be signed

generateRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> generateRequestHeaders(java.lang.String httpVerb,
                                                                               java.lang.String requestPath,
                                                                               java.io.InputStream requestPayload,
                                                                               java.lang.String queryParameters)
                                                                        throws com.mdsol.mauth.exceptions.MAuthSigningException

Description copied from interface: Signer

Generates the mAuth headers from the provided HTTP request data for Mauth V2 or V1 protocol NOTE: mAuth headers are time sensitive. The headers must be verified by the receiving service within 5 minutes of being generated otherwise the request will fail.

Specified by:

generateRequestHeaders in interface Signer

Parameters:

httpVerb - The HTTP verb of the request, e.g. GET, POST, etc.

requestPath - The path of the request, not including protocol, host or query parameters.

requestPayload - The payload of the request

queryParameters - The query parameters (URL-encoded)

Returns:

MAuth headers which should be appended to the request before sending.

Throws:

com.mdsol.mauth.exceptions.MAuthSigningException - when request cannot be signed