com.ibm.cos.v2.http.auth.aws.internal.signer

Interface V4RequestSigner

All Known Implementing Classes:

DefaultV4RequestSigner

public interface V4RequestSigner

An interface which declares an algorithm that takes a request and a content-hash and signs the request according to the SigV4 process.

Method Summary

Modifier and Type	Method and Description
static V4RequestSigner	anonymous(V4Properties properties) Retrieve an implementation of a V4RequestSigner to handle the anonymous credentials case, where the request is not sigend at all.
static V4RequestSigner	create(V4Properties properties, String contentHash) Retrieve an implementation of a V4RequestSigner, which signs the request, but does not add authentication to the request.
static V4RequestSigner	header(V4Properties properties) Retrieve an implementation of a V4RequestSigner, which signs the request and adds authentication through headers.
static V4RequestSigner	presigned(V4Properties properties, Duration expirationDuration) Retrieve an implementation of a V4RequestSigner, which signs the request and adds authentication through query parameters, which includes an expiration param, signalling how long a request signature is valid.
static V4RequestSigner	query(V4Properties properties) Retrieve an implementation of a V4RequestSigner, which signs the request and adds authentication through query parameters.
V4RequestSigningResult	sign(SdkHttpRequest.Builder requestBuilder) Given a request builder, sign the request and return a result containing the signed request and its properties.

Method Detail

create

static V4RequestSigner create(V4Properties properties,
                              String contentHash)

Retrieve an implementation of a V4RequestSigner, which signs the request, but does not add authentication to the request.

header

static V4RequestSigner header(V4Properties properties)

Retrieve an implementation of a V4RequestSigner, which signs the request and adds authentication through headers.

query

static V4RequestSigner query(V4Properties properties)

Retrieve an implementation of a V4RequestSigner, which signs the request and adds authentication through query parameters.

presigned

static V4RequestSigner presigned(V4Properties properties,
                                 Duration expirationDuration)

Retrieve an implementation of a V4RequestSigner, which signs the request and adds authentication through query parameters, which includes an expiration param, signalling how long a request signature is valid.

anonymous

static V4RequestSigner anonymous(V4Properties properties)

Retrieve an implementation of a V4RequestSigner to handle the anonymous credentials case, where the request is not sigend at all.

sign

V4RequestSigningResult sign(SdkHttpRequest.Builder requestBuilder)

Given a request builder, sign the request and return a result containing the signed request and its properties.