Package com.oracle.bmc.http.signing.internal

Class RequestSignerImpl

java.lang.Object

com.oracle.bmc.http.signing.internal.RequestSignerImpl

All Implemented Interfaces:

RequestSigner

@Immutable
public class RequestSignerImpl
extends Object
implements RequestSigner

Implementation of the RequestSigner interface

This contains the main code that is used for signing a request

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestSignerImpl.SigningConfiguration	Basic configuration of what headers to sign.

Constructor Summary

Constructors

Constructor	Description
RequestSignerImpl(KeySupplier<RSAPrivateKey> keySupplier, RequestSignerImpl.SigningConfiguration signingConfiguration, Supplier<String> keyIdSupplier)	Construct the RequestSigner with the specified KeySupplier.
RequestSignerImpl(KeySupplier<RSAPrivateKey> keySupplier, SigningStrategy signingStrategy, Supplier<String> keyIdSupplier)	Construct the RequestSigner with the specified KeySupplier.
RequestSignerImpl(SigningStrategy signingStrategy, KeySupplier<PrivateKey> keySupplier, Supplier<String> keyIdSupplier)

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	signRequest(Algorithm algorithm, URI uri, String httpMethod, Map<String,List<String>> headers, Object body, String versionName, String keyId, KeySupplier<RSAPrivateKey> keySupplier, RequestSignerImpl.SigningConfiguration signingConfiguration)
Map<String,String>	signRequest(URI uri, String httpMethod, Map<String,List<String>> headers, Object body)	Sign a request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestSignerImpl

public RequestSignerImpl(@Nonnull
                         KeySupplier<RSAPrivateKey> keySupplier,
                         @Nonnull
                         SigningStrategy signingStrategy,
                         @Nonnull
                         Supplier<String> keyIdSupplier)

Construct the RequestSigner with the specified KeySupplier.

This will be used to get keys for doing the signing.

Parameters:

keySupplier - A key supplier that will be used for signing the request

signingStrategy - The signing strategy to determine what headers to use

keyIdSupplier - A keyId supplier that will be used for signing the request

RequestSignerImpl

public RequestSignerImpl(@Nonnull
                         SigningStrategy signingStrategy,
                         @Nonnull
                         KeySupplier<PrivateKey> keySupplier,
                         @Nonnull
                         Supplier<String> keyIdSupplier)

RequestSignerImpl

public RequestSignerImpl(@Nonnull
                         KeySupplier<RSAPrivateKey> keySupplier,
                         @Nonnull
                         RequestSignerImpl.SigningConfiguration signingConfiguration,
                         @Nonnull
                         Supplier<String> keyIdSupplier)

Construct the RequestSigner with the specified KeySupplier.

This will be used to get keys for doing the signing.

Parameters:

keySupplier - A key supplier that will be used for signing the request

signingConfiguration - The signing configuration to determine what headers to use

keyIdSupplier - A keyId supplier that will be used for signing the request

Method Detail

signRequest

public Map<String,String> signRequest(@Nonnull
                                            URI uri,
                                            @Nonnull
                                            String httpMethod,
                                            @Nonnull
                                            Map<String,List<String>> headers,
                                            @Nullable
                                            Object body)

Description copied from interface: RequestSigner

Sign a request.

Specified by:

signRequest in interface RequestSigner

Parameters:

uri - the request uri

httpMethod - the request method

headers - the request headers

body - the request body (if this is a PUT or POST method)

Returns:

a map that contains the signature Authorization header, and any headers that were signed when generating the signature. You MUST include the exact values of the returned headers when making requests.

signRequest

public static Map<String,String> signRequest(Algorithm algorithm,
                                                   URI uri,
                                                   String httpMethod,
                                                   Map<String,List<String>> headers,
                                                   Object body,
                                                   String versionName,
                                                   String keyId,
                                                   KeySupplier<RSAPrivateKey> keySupplier,
                                                   RequestSignerImpl.SigningConfiguration signingConfiguration)