com.ibm.cloud.objectstorage.auth.internal

Class AWS4SignerRequestParams

java.lang.Object

com.ibm.cloud.objectstorage.auth.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(SignableRequest<?> request, Date signingDateOverride, String regionNameOverride, String serviceName, String signingAlgorithm) Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request
AWS4SignerRequestParams(SignableRequest<?> request, Date signingDateOverride, String regionNameOverride, String serviceName, String signingAlgorithm, String endpointPrefix) Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request
AWS4SignerRequestParams(SignableRequest<?> request, Date signingDateOverride, String regionNameOverride, String serviceName, String signingAlgorithm, String endpointPrefix, RegionFromEndpointResolver regionFromEndpointResolver) Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request

Method Summary

Modifier and Type	Method and Description
String	getFormattedSigningDate() Returns the formatted date in UTC zone of the signing date.
String	getFormattedSigningDateTime() Returns the formatted date and time of the signing date in UTC zone.
String	getRegionName() Returns the AWS region name to be used while computing the signature.
SignableRequest<?>	getRequest() Returns the request for which the signing needs to be done.
String	getScope() Returns the scope of the signing.
String	getServiceName() Returns the AWS Service name to be used while computing the signature.
String	getSigningAlgorithm() Returns the signing algorithm used for computing the signature.
long	getSigningDateTimeMilli() Returns the signing date time in millis for which the signature needs to be computed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AWS4SignerRequestParams

public AWS4SignerRequestParams(SignableRequest<?> request,
                               Date signingDateOverride,
                               String regionNameOverride,
                               String serviceName,
                               String signingAlgorithm)

Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request

AWS4SignerRequestParams

public AWS4SignerRequestParams(SignableRequest<?> request,
                               Date signingDateOverride,
                               String regionNameOverride,
                               String serviceName,
                               String signingAlgorithm,
                               String endpointPrefix)

Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request

AWS4SignerRequestParams

public AWS4SignerRequestParams(SignableRequest<?> request,
                               Date signingDateOverride,
                               String regionNameOverride,
                               String serviceName,
                               String signingAlgorithm,
                               String endpointPrefix,
                               RegionFromEndpointResolver regionFromEndpointResolver)

Generates an instance of AWS4signerRequestParams that holds the parameters used for computing a AWS 4 signature for a request

Method Detail

getRequest

public SignableRequest<?> getRequest()

Returns the request for which the signing needs to be done.

getScope

public String getScope()

Returns the scope of the signing.

getFormattedSigningDateTime

public String getFormattedSigningDateTime()

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

getSigningDateTimeMilli

public long getSigningDateTimeMilli()

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

getRegionName

public String getRegionName()

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

getServiceName

public String getServiceName()

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

getFormattedSigningDate

public String getFormattedSigningDate()

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

getSigningAlgorithm

public String getSigningAlgorithm()

Returns the signing algorithm used for computing the signature.