Class InternalPropertyEncryptionRequest

java.lang.Object

org.neo4j.driver.internal.encryption.InternalPropertyEncryptionRequest

All Implemented Interfaces:

PropertyEncryptionRequest, PropertyEncryptionRequest.Builder.AADStep, PropertyEncryptionRequest.Builder.BuildStep, PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep, PropertyEncryptionRequest.Builder.ProfileStep, PropertyEncryptionRequest.Builder.ValueStep

public final class InternalPropertyEncryptionRequest
extends Object
implements PropertyEncryptionRequest.Builder.ProfileStep, PropertyEncryptionRequest.Builder.ValueStep, PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep, PropertyEncryptionRequest.Builder.AADStep, PropertyEncryptionRequest.Builder.BuildStep, PropertyEncryptionRequest

Nested Class Summary

Nested classes/interfaces inherited from interface PropertyEncryptionRequest

PropertyEncryptionRequest.Builder

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final TypeSystem	TYPE_SYSTEM

Constructor Summary

Constructors

Constructor	Description
InternalPropertyEncryptionRequest()

Method Summary

Modifier and Type	Method	Description
PropertyEncryptionRequest	build()	Builds and returns a new PropertyEncryptionRequest instance.
PropertyEncryptionRequest.Builder.AADStep	fromValue(Value value)	Sets the value to encrypt.
PropertyEncryptionRequest.Builder.BuildStep	usingKeyAlias(String keyAlias)	Sets the key alias to use.
PropertyEncryptionRequest.Builder.BuildStep	usingKeyId(String keyId)	Sets the key id to use.
PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep	usingProfile(String profileName)	Sets the profile name to use.
protected void	validate(Value value)
protected void	validateAad(Value value)
PropertyEncryptionRequest.Builder.AADStep	withAAD(Value aad)	Adds the supplied value as AAD for encryption request.

Methods inherited from class Object

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

Methods inherited from interface PropertyEncryptionRequest.Builder.AADStep

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

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.

Methods inherited from interface PropertyEncryptionRequest.Builder.ValueStep

fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue, fromValue

Modifier and Type	Method	Description
default PropertyEncryptionRequest.Builder.AADStep	fromValue(boolean value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(boolean... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(byte... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(char value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(char... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(double value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(double... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(float... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(int value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(int... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(long value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(long... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(short... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(String value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(String... values)	Sets the values to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(Duration value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(LocalDate value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(LocalDateTime value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(LocalTime value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(OffsetDateTime value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(OffsetTime value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(Period value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(ZonedDateTime value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(UUID value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(IsoDuration value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(Point value)	Sets the value to encrypt.
default PropertyEncryptionRequest.Builder.AADStep	fromValue(Vector value)	Sets the value to encrypt.

Field Details

TYPE_SYSTEM

protected static final TypeSystem TYPE_SYSTEM

Constructor Details

InternalPropertyEncryptionRequest

public InternalPropertyEncryptionRequest()

Method Details

usingProfile

public PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep usingProfile(String profileName)

Description copied from interface: PropertyEncryptionRequest.Builder.ProfileStep

Sets the profile name to use.

Specified by:

usingProfile in interface PropertyEncryptionRequest.Builder.ProfileStep

Parameters:

profileName - the profile name, must not be null

Returns:

the next builder step

fromValue

public PropertyEncryptionRequest.Builder.AADStep fromValue(Value value)

Description copied from interface: PropertyEncryptionRequest.Builder.ValueStep

Sets the value to encrypt.

Note that the value MUST be of a supported Neo4j Property Type.

Specified by:

fromValue in interface PropertyEncryptionRequest.Builder.ValueStep

Parameters:

value - the value to encrypt

Returns:

the next builder step

usingKeyId

public PropertyEncryptionRequest.Builder.BuildStep usingKeyId(String keyId)

Description copied from interface: PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep

Sets the key id to use.

Specified by:

usingKeyId in interface PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep

Parameters:

keyId - the key id, must not be null

Returns:

the next builder step

usingKeyAlias

public PropertyEncryptionRequest.Builder.BuildStep usingKeyAlias(String keyAlias)

Description copied from interface: PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep

Sets the key alias to use.

Specified by:

usingKeyAlias in interface PropertyEncryptionRequest.Builder.EncryptionKeyReferenceStep

Parameters:

keyAlias - the key alias, must not be null

Returns:

the next builder step

withAAD

public PropertyEncryptionRequest.Builder.AADStep withAAD(Value aad)

Description copied from interface: PropertyEncryptionRequest.Builder.AADStep

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()

Specified by:

withAAD in interface PropertyEncryptionRequest.Builder.AADStep

Parameters:

aad - the AAD value, must not be null

Returns:

the next builder step

build

public PropertyEncryptionRequest build()

Description copied from interface: PropertyEncryptionRequest.Builder.BuildStep

Builds and returns a new PropertyEncryptionRequest instance.

Specified by:

build in interface PropertyEncryptionRequest.Builder.BuildStep

Returns:

the new request instance

validate

protected void validate(Value value)

validateAad

protected void validateAad(Value value)