Interface PropertyEncryptionRequest.Builder.AADStep

All Superinterfaces:

PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep, PropertyEncryptionRequest.Builder.ProfileStep

All Known Implementing Classes:

InternalPropertyEncryptionRequest

Enclosing interface:

PropertyEncryptionRequest.Builder

public static interface PropertyEncryptionRequest.Builder.AADStep
extends PropertyEncryptionRequest.Builder.ProfileStep

A builder step for setting AAD.

Since:

6.3.0

Method Summary

Modifier and Type	Method	Description
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(boolean aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(byte[] aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(double aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(int aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(long aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(String aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(LocalDate aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(LocalTime aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(OffsetTime aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(UUID aad)	Adds the supplied value as AAD for encryption request.
default PropertyEncryptionRequest.Builder.ProfileStep	withAAD(Point aad)	Adds the supplied value as AAD for encryption request.
PropertyEncryptionRequest.Builder.ProfileStep	withAAD(Value aad)	Adds the supplied value as AAD for encryption request.

Methods inherited from interface PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep

usingKeyAlias, usingKeyId

Modifier and Type	Method	Description
PropertyEncryptionRequest.Builder.BuildStep	usingKeyAlias(String keyAlias)	Sets the key alias to use.
PropertyEncryptionRequest.Builder.BuildStep	usingKeyId(String keyId)	Sets the key id to use.

Methods inherited from interface PropertyEncryptionRequest.Builder.ProfileStep

usingProfile

Modifier and Type	Method	Description
PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep	usingProfile(String profileName)	Sets the profile name to use.

Method Details

withAAD

PropertyEncryptionRequest.Builder.ProfileStep withAAD(Value aad)

Adds the supplied value as AAD for encryption request.

Note that only a subset of types is supported for AAD, they are listed below:

• TypeSystem.BOOLEAN()
• TypeSystem.BYTES()
• TypeSystem.STRING() - it is strongly recommended to normalize the value, for example using Normalizer.Form.NFC, before passing it to the driver
• TypeSystem.INTEGER()
• TypeSystem.POINT()
• TypeSystem.DATE()
• TypeSystem.TIME()
• TypeSystem.LOCAL_TIME()
• TypeSystem.UUID()

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(boolean aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(LocalDate aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(OffsetTime aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(LocalTime aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(double aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(int aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(long aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(Point aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(String aad)

Adds the supplied value as AAD for encryption request.

It is strongly recommended to normalize the value, for example using Normalizer.Form.NFC, before passing it to the driver.

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(UUID aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withAAD

default PropertyEncryptionRequest.Builder.ProfileStep withAAD(byte[] aad)

Adds the supplied value as AAD for encryption request.

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step