Class InternalEnvelopePropertyEncryptionProfile.Builder

java.lang.Object

org.neo4j.driver.internal.encryption.InternalEnvelopePropertyEncryptionProfile.Builder

All Implemented Interfaces:

EnvelopePropertyEncryptionProfile.Builder

Enclosing class:

InternalEnvelopePropertyEncryptionProfile

public static class InternalEnvelopePropertyEncryptionProfile.Builder
extends Object
implements EnvelopePropertyEncryptionProfile.Builder

Constructor Summary

Constructors

Constructor	Description
Builder(String name, BaseKeyEncapsulationService keyEncapsulationService, BaseEncapsulatedKeyRecordRepository keyRepository)

Method Summary

Modifier and Type	Method	Description
EnvelopePropertyEncryptionProfile	build()	Returns a new instance of EnvelopePropertyEncryptionProfile.
InternalEnvelopePropertyEncryptionProfile.Builder	withCryptoContext(Provider provider, SecureRandom ivSecureRandom)	Configures the CryptoContext to be used for cryptographic operations.
InternalEnvelopePropertyEncryptionProfile.Builder	withKeyAliasIndex(int maxSize, Duration ttl)	Configures the key alias index.
InternalEnvelopePropertyEncryptionProfile.Builder	withKeyCache(int maxSize, Duration ttl)	Configures the key cache.
InternalEnvelopePropertyEncryptionProfile.Builder	withoutKeyAliasIndex()	Disables the key alias index.
InternalEnvelopePropertyEncryptionProfile.Builder	withoutKeyCache()	Disables the key cache.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder(String name,
 BaseKeyEncapsulationService keyEncapsulationService,
 BaseEncapsulatedKeyRecordRepository keyRepository)

Method Details

withCryptoContext

public InternalEnvelopePropertyEncryptionProfile.Builder withCryptoContext(Provider provider,
 SecureRandom ivSecureRandom)

Description copied from interface: EnvelopePropertyEncryptionProfile.Builder

Configures the CryptoContext to be used for cryptographic operations.

The supplied Provider is used to create the Cipher for "AES/GCM/NoPadding". The provider must support this cipher transformation. The supplied SecureRandom is used as the source of the 12-byte initialization vectors (IVs) required for encryption.

Specified by:

withCryptoContext in interface EnvelopePropertyEncryptionProfile.Builder

Parameters:

provider - the Provider, must not be null

ivSecureRandom - the SecureRandom for IV generation, must not be null and SecureRandom.getProvider() must resolve to the provider parameter

Returns:

this builder

withKeyCache

public InternalEnvelopePropertyEncryptionProfile.Builder withKeyCache(int maxSize,
 Duration ttl)

Description copied from interface: EnvelopePropertyEncryptionProfile.Builder

Configures the key cache.

The key cache stores mappings from key ids to decapsulated keys. This is especially useful when the configured key repository or key encapsulation service requires network exchanges.

The cache is enabled by default with a maximum size of 100 entries and an entry TTL of 15 minutes. When adding a new entry, expired entries are purged first. If the cache is still at its maximum size, the least recently used entry is evicted.

Key ids are expected to be globally unique, so the TTL can be configured to be longer if avoiding repeated key decapsulation is preferred. A longer TTL also means that decapsulated keys remain in memory for longer and are not refreshed or removed from the cache as frequently.

Specified by:

withKeyCache in interface EnvelopePropertyEncryptionProfile.Builder

Parameters:

maxSize - the maximum cache size, must be greater than 0

ttl - the entry TTL, must not be null, Duration.isNegative() or Duration.isZero()

Returns:

this builder

withoutKeyCache

public InternalEnvelopePropertyEncryptionProfile.Builder withoutKeyCache()

Description copied from interface: EnvelopePropertyEncryptionProfile.Builder

Disables the key cache.

Disabling the key cache also disables the key alias index.

Specified by:

withoutKeyCache in interface EnvelopePropertyEncryptionProfile.Builder

Returns:

this builder

withKeyAliasIndex

public InternalEnvelopePropertyEncryptionProfile.Builder withKeyAliasIndex(int maxSize,
 Duration ttl)

Description copied from interface: EnvelopePropertyEncryptionProfile.Builder

Configures the key alias index.

The key alias index stores mappings from key aliases to key ids. This is especially useful when the configured key repository or key encapsulation service requires network exchanges. The key alias index can only be enabled when the key cache is enabled.

The index is enabled by default with a maximum size of 100 entries and an entry TTL of 15 seconds.

A shorter TTL allows an alias to be removed from one key and assigned to another key while limiting the period during which a driver may use a cached mapping to the previous key, allowing for predictable alias reassignment.

Specified by:

withKeyAliasIndex in interface EnvelopePropertyEncryptionProfile.Builder

Parameters:

maxSize - the maximum cache size, must be greater than 0

ttl - the entry TTL, must not be null, Duration.isNegative() or Duration.isZero()

Returns:

this builder

withoutKeyAliasIndex

public InternalEnvelopePropertyEncryptionProfile.Builder withoutKeyAliasIndex()

Description copied from interface: EnvelopePropertyEncryptionProfile.Builder

Disables the key alias index.

Specified by:

withoutKeyAliasIndex in interface EnvelopePropertyEncryptionProfile.Builder

Returns:

this builder

build

public EnvelopePropertyEncryptionProfile build()

Description copied from interface: EnvelopePropertyEncryptionProfile.Builder

Returns a new instance of EnvelopePropertyEncryptionProfile.

Specified by:

build in interface EnvelopePropertyEncryptionProfile.Builder

Returns:

the new instance of profile