Interface PropertyDecryptionRequest.Builder.AADStep
- All Known Implementing Classes:
InternalPropertyDecryptionRequest
- Enclosing interface:
PropertyDecryptionRequest.Builder
public static interface PropertyDecryptionRequest.Builder.AADStep
A builder step for setting AAD.
- Since:
- 6.3.0
-
Method Summary
Modifier and TypeMethodDescriptionwithAAD(boolean aad) Adds the supplied value as AAD for decryption request.withAAD(byte[] aad) Adds the supplied value as AAD for decryption request.withAAD(double aad) Adds the supplied value as AAD for decryption request.withAAD(int aad) Adds the supplied value as AAD for decryption request.withAAD(long aad) Adds the supplied value as AAD for decryption request.Adds the supplied value as AAD for decryption request.Adds the supplied value as AAD for decryption request.Adds the supplied value as AAD for decryption request.withAAD(OffsetTime aad) Adds the supplied value as AAD for decryption request.Adds the supplied value as AAD for decryption request.Adds the supplied value as AAD for decryption request.Adds the supplied value as AAD for decryption request.Enables using the AAD configuration recorded in the encrypted value metadata.
-
Method Details
-
withAAD
Adds the supplied value as AAD for decryption request.Note that only a subset of types is supported for AAD, they are listed below:
TypeSystem.BOOLEAN()TypeSystem.BYTES()TypeSystem.STRING()- the value must use the same normalization as the value supplied during encryption if it was normalizedTypeSystem.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
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value, must not be null- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value, must not be null- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value, must not be null- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value, must not be null- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.The value must use the same normalization as the value supplied during encryption if it was normalized.
- Parameters:
aad- the AAD value, must not be null- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value, must not be null- Returns:
- the next builder step
-
withAAD
Adds the supplied value as AAD for decryption request.- Parameters:
aad- the AAD value, must not be null- Returns:
- the next builder step
-
withoutExternalAAD
PropertyDecryptionRequest.Builder.BuildStep withoutExternalAAD()Enables using the AAD configuration recorded in the encrypted value metadata.If AAD was used during encryption, the persisted AAD is used for decryption. If no AAD was used during encryption, no effective AAD is used during decryption.
This option does not bind the encrypted value to an independently supplied external context. If AAD needs to bind the encrypted value to an external context, use an explicit AAD value using
withAAD(Value)or an overloaded variant of it.- Returns:
- the next builder step
-