Class Aws4SignerParams.BuilderImpl<B extends Aws4SignerParams.Builder<B>>
- java.lang.Object
-
- software.amazon.awssdk.auth.signer.params.Aws4SignerParams.BuilderImpl<B>
-
- All Implemented Interfaces:
Aws4SignerParams.Builder<B>
- Enclosing class:
- Aws4SignerParams
protected static class Aws4SignerParams.BuilderImpl<B extends Aws4SignerParams.Builder<B>> extends Object implements Aws4SignerParams.Builder<B>
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
BuilderImpl()
protected
BuilderImpl(Aws4SignerParams params)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description B
awsCredentials(AwsCredentials awsCredentials)
Sets the aws credentials to use for computing the signature.Aws4SignerParams
build()
B
checksumParams(SignerChecksumParams checksumParams)
Checksum params required to compute the Checksum while data is read for signing the Checksum.B
doubleUrlEncode(Boolean doubleUrlEncode)
Set this value to double url-encode the resource path when constructing the canonical request.B
normalizePath(Boolean normalizePath)
Whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request.void
setAwsCredentials(AwsCredentials awsCredentials)
void
setDoubleUrlEncode(Boolean doubleUrlEncode)
void
setNormalizePath(Boolean normalizePath)
void
setSigningClockOverride(Clock signingClockOverride)
void
setSigningName(String signingName)
void
setSigningRegion(Region signingRegion)
void
setTimeOffset(Integer timeOffset)
B
signingClockOverride(Clock signingClockOverride)
The clock to use for overriding the signing time when computing signature for a request.B
signingName(String signingName)
The name of the AWS service to be used for computing the signature.B
signingRegion(Region signingRegion)
The AWS region to be used for computing the signature.B
timeOffset(Integer timeOffset)
The time offset (for clock skew correction) to use when computing the signing date for the request.
-
-
-
Constructor Detail
-
BuilderImpl
protected BuilderImpl()
-
BuilderImpl
protected BuilderImpl(Aws4SignerParams params)
-
-
Method Detail
-
doubleUrlEncode
public B doubleUrlEncode(Boolean doubleUrlEncode)
Description copied from interface:Aws4SignerParams.Builder
Set this value to double url-encode the resource path when constructing the canonical request. By default, all services except S3 enable double url-encoding.- Specified by:
doubleUrlEncode
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
- Parameters:
doubleUrlEncode
- Set true to enable double url encoding. Otherwise false.
-
setDoubleUrlEncode
public void setDoubleUrlEncode(Boolean doubleUrlEncode)
-
normalizePath
public B normalizePath(Boolean normalizePath)
Description copied from interface:Aws4SignerParams.Builder
Whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request. By default, all services except S3 enable resource path normalization.- Specified by:
normalizePath
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
-
setNormalizePath
public void setNormalizePath(Boolean normalizePath)
-
awsCredentials
public B awsCredentials(AwsCredentials awsCredentials)
Description copied from interface:Aws4SignerParams.Builder
Sets the aws credentials to use for computing the signature.- Specified by:
awsCredentials
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
- Parameters:
awsCredentials
- Aws Credentials to use for computing the signature.
-
setAwsCredentials
public void setAwsCredentials(AwsCredentials awsCredentials)
-
signingName
public B signingName(String signingName)
Description copied from interface:Aws4SignerParams.Builder
The name of the AWS service to be used for computing the signature.- Specified by:
signingName
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
- Parameters:
signingName
- Name of the AWS service to be used for computing the signature.
-
setSigningName
public void setSigningName(String signingName)
-
signingRegion
public B signingRegion(Region signingRegion)
Description copied from interface:Aws4SignerParams.Builder
The AWS region to be used for computing the signature.- Specified by:
signingRegion
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
- Parameters:
signingRegion
- AWS region to be used for computing the signature.
-
setSigningRegion
public void setSigningRegion(Region signingRegion)
-
timeOffset
public B timeOffset(Integer timeOffset)
Description copied from interface:Aws4SignerParams.Builder
The time offset (for clock skew correction) to use when computing the signing date for the request.- Specified by:
timeOffset
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
- Parameters:
timeOffset
- The time offset (for clock skew correction) to use when computing the signing date for the request.
-
setTimeOffset
public void setTimeOffset(Integer timeOffset)
-
signingClockOverride
public B signingClockOverride(Clock signingClockOverride)
Description copied from interface:Aws4SignerParams.Builder
The clock to use for overriding the signing time when computing signature for a request. By default, current time of the system is used for signing. This parameter can be used to set custom signing time. Useful option for testing.- Specified by:
signingClockOverride
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
- Parameters:
signingClockOverride
- The clock to use for overriding the signing time when computing signature for a request.
-
checksumParams
public B checksumParams(SignerChecksumParams checksumParams)
Description copied from interface:Aws4SignerParams.Builder
Checksum params required to compute the Checksum while data is read for signing the Checksum.- Specified by:
checksumParams
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
- Parameters:
checksumParams
- SignerChecksumParams that defines the Algorithm and headers to pass Checksum.- Returns:
-
setSigningClockOverride
public void setSigningClockOverride(Clock signingClockOverride)
-
build
public Aws4SignerParams build()
- Specified by:
build
in interfaceAws4SignerParams.Builder<B extends Aws4SignerParams.Builder<B>>
-
-