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

Class Aws4SignerRequestParams

java.lang.Object

com.ibm.cos.v2.auth.signer.internal.Aws4SignerRequestParams

public final class Aws4SignerRequestParams
extends Object

Parameters that are used for computing a AWS 4 signature for a request.

Constructor Summary

Constructors

Constructor and Description
Aws4SignerRequestParams(Aws4SignerParams signerParams) Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request based on the given Aws4SignerParams for that request.

Method Summary

Modifier and Type	Method and Description
String	getFormattedRequestSigningDate() Returns the formatted date in UTC zone of the signing date for the request.
String	getFormattedRequestSigningDateTime() Returns the formatted date and time of the request signing date in UTC zone.
String	getRegionName() Returns the AWS region name to be used while computing the signature.
long	getRequestSigningDateTimeMilli() Returns the request signing date time in millis for which the request signature needs to be computed.
String	getScope() Returns the scope of the request signing.
String	getServiceSigningName() Returns the AWS Service name to be used while computing the signature.
String	getSigningAlgorithm() Returns the signing algorithm used for computing the signature.
Clock	getSigningClock()

Methods inherited from class java.lang.Object

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

Constructor Detail

Aws4SignerRequestParams

public Aws4SignerRequestParams(Aws4SignerParams signerParams)

Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request based on the given Aws4SignerParams for that request.

Method Detail

getSigningClock

public Clock getSigningClock()

Returns:

The clock to use for signing additional data i.e. events or chunks.

getScope

public String getScope()

Returns the scope of the request signing.

getFormattedRequestSigningDateTime

public String getFormattedRequestSigningDateTime()

Returns the formatted date and time of the request signing date in UTC zone.

getRequestSigningDateTimeMilli

public long getRequestSigningDateTimeMilli()

Returns the request signing date time in millis for which the request signature needs to be computed.

getRegionName

public String getRegionName()

Returns the AWS region name to be used while computing the signature.

getServiceSigningName

public String getServiceSigningName()

Returns the AWS Service name to be used while computing the signature.

getFormattedRequestSigningDate

public String getFormattedRequestSigningDate()

Returns the formatted date in UTC zone of the signing date for the request.

getSigningAlgorithm

public String getSigningAlgorithm()

Returns the signing algorithm used for computing the signature.