Class InternalPropertyDecryptionRequest

java.lang.Object

org.neo4j.driver.internal.encryption.InternalPropertyDecryptionRequest

All Implemented Interfaces:

PropertyDecryptionRequest, PropertyDecryptionRequest.Builder.AADStep, PropertyDecryptionRequest.Builder.BuildStep, PropertyDecryptionRequest.Builder.ValueStep

public final class InternalPropertyDecryptionRequest
extends Object
implements PropertyDecryptionRequest.Builder.ValueStep, PropertyDecryptionRequest.Builder.AADStep, PropertyDecryptionRequest.Builder.BuildStep, PropertyDecryptionRequest

Nested Class Summary

Nested classes/interfaces inherited from interface PropertyDecryptionRequest

PropertyDecryptionRequest.Builder

Modifier and Type	Interface	Description
static interface	PropertyDecryptionRequest.Builder	A builder for PropertyEncryptionRequest.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final TypeSystem	TYPE_SYSTEM

Constructor Summary

Constructors

Constructor	Description
InternalPropertyDecryptionRequest()

Method Summary

Modifier and Type	Method	Description
PropertyDecryptionRequest	build()	Builds and returns a new PropertyDecryptionRequest instance.
PropertyDecryptionRequest.Builder.AADStep	fromValue(byte[] value)	Sets the value to decrypt.
protected void	validate(Value value)
protected void	validateAad(Value value)
PropertyDecryptionRequest.Builder.BuildStep	withAAD(Value aad)	Adds the supplied value as AAD for decryption request.
PropertyDecryptionRequest.Builder.BuildStep	withoutExternalAAD()	Enables using the AAD configuration recorded in the encrypted value metadata.

Methods inherited from class Object

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

Methods inherited from interface PropertyDecryptionRequest.Builder.AADStep

withAAD, withAAD, withAAD, withAAD, withAAD, withAAD, withAAD, withAAD, withAAD, withAAD, withAAD

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

Field Details

TYPE_SYSTEM

protected static final TypeSystem TYPE_SYSTEM

Constructor Details

InternalPropertyDecryptionRequest

public InternalPropertyDecryptionRequest()

Method Details

fromValue

public PropertyDecryptionRequest.Builder.AADStep fromValue(byte[] value)

Description copied from interface: PropertyDecryptionRequest.Builder.ValueStep

Sets the value to decrypt.

Specified by:

fromValue in interface PropertyDecryptionRequest.Builder.ValueStep

Parameters:

value - the value to decrypt

Returns:

the next builder step

withAAD

public PropertyDecryptionRequest.Builder.BuildStep withAAD(Value aad)

Description copied from interface: PropertyDecryptionRequest.Builder.AADStep

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 normalized
• TypeSystem.INTEGER()
• TypeSystem.POINT()
• TypeSystem.DATE()
• TypeSystem.TIME()
• TypeSystem.LOCAL_TIME()
• TypeSystem.UUID()

Specified by:

withAAD in interface PropertyDecryptionRequest.Builder.AADStep

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

withoutExternalAAD

public PropertyDecryptionRequest.Builder.BuildStep withoutExternalAAD()

Description copied from interface: PropertyDecryptionRequest.Builder.AADStep

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 PropertyDecryptionRequest.Builder.AADStep.withAAD(Value) or an overloaded variant of it.

Specified by:

withoutExternalAAD in interface PropertyDecryptionRequest.Builder.AADStep

Returns:

the next builder step

build

public PropertyDecryptionRequest build()

Description copied from interface: PropertyDecryptionRequest.Builder.BuildStep

Builds and returns a new PropertyDecryptionRequest instance.

Specified by:

build in interface PropertyDecryptionRequest.Builder.BuildStep

Returns:

the new request instance

validate

protected void validate(Value value)

validateAad

protected void validateAad(Value value)