Record Class InternalEnvelopePropertyEncryptionProfile

java.lang.Object
java.lang.Record
org.neo4j.driver.internal.encryption.InternalEnvelopePropertyEncryptionProfile
All Implemented Interfaces:
EnvelopePropertyEncryptionProfile, PropertyEncryptionProfile

public record InternalEnvelopePropertyEncryptionProfile(String name, BaseKeyEncapsulationService keyEncapsulationService, AsyncKeyEncapsulationService asyncKeyEncapsulationService, BaseEncapsulatedKeyRecordRepository keyRepository, AsyncEncapsulatedKeyRecordRepository asyncKeyRepository, CryptoContext cryptoContextRef, CacheConfig keyCacheConfigRef, CacheConfig keyAliasCacheConfigRef) extends Record implements EnvelopePropertyEncryptionProfile
  • Constructor Details

    • InternalEnvelopePropertyEncryptionProfile

      public InternalEnvelopePropertyEncryptionProfile(String name, BaseKeyEncapsulationService keyEncapsulationService, AsyncKeyEncapsulationService asyncKeyEncapsulationService, BaseEncapsulatedKeyRecordRepository keyRepository, AsyncEncapsulatedKeyRecordRepository asyncKeyRepository, CryptoContext cryptoContextRef, CacheConfig keyCacheConfigRef, CacheConfig keyAliasCacheConfigRef)
      Creates an instance of a InternalEnvelopePropertyEncryptionProfile record class.
      Parameters:
      name - the value for the name record component
      keyEncapsulationService - the value for the keyEncapsulationService record component
      asyncKeyEncapsulationService - the value for the asyncKeyEncapsulationService record component
      keyRepository - the value for the keyRepository record component
      asyncKeyRepository - the value for the asyncKeyRepository record component
      cryptoContextRef - the value for the cryptoContextRef record component
      keyCacheConfigRef - the value for the keyCacheConfigRef record component
      keyAliasCacheConfigRef - the value for the keyAliasCacheConfigRef record component
  • Method Details

    • cryptoContext

      public Optional<CryptoContext> cryptoContext()
      Description copied from interface: EnvelopePropertyEncryptionProfile
      Returns CryptoContext if set.

      If no context is configured, the Java runtime selects the AES-GCM provider and secure random number generator according to its configuration.

      Specified by:
      cryptoContext in interface EnvelopePropertyEncryptionProfile
      Returns:
      the crypto context
    • keyCacheConfig

      public Optional<CacheConfig> keyCacheConfig()
      Description copied from interface: EnvelopePropertyEncryptionProfile
      Returns the key cache CacheConfig if enabled.

      The cache is enabled by default with a maximum size of 100 entries and a TTL of 15 minutes.

      Specified by:
      keyCacheConfig in interface EnvelopePropertyEncryptionProfile
      Returns:
      the cache config
    • keyAliasIndexConfig

      public Optional<CacheConfig> keyAliasIndexConfig()
      Description copied from interface: EnvelopePropertyEncryptionProfile
      Returns the key alias index CacheConfig if enabled.

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

      Specified by:
      keyAliasIndexConfig in interface EnvelopePropertyEncryptionProfile
      Returns:
      the cache config
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface PropertyEncryptionProfile
      Returns:
      the value of the name record component
    • keyEncapsulationService

      public BaseKeyEncapsulationService keyEncapsulationService()
      Returns the value of the keyEncapsulationService record component.
      Specified by:
      keyEncapsulationService in interface EnvelopePropertyEncryptionProfile
      Returns:
      the value of the keyEncapsulationService record component
    • asyncKeyEncapsulationService

      public AsyncKeyEncapsulationService asyncKeyEncapsulationService()
      Returns the value of the asyncKeyEncapsulationService record component.
      Returns:
      the value of the asyncKeyEncapsulationService record component
    • keyRepository

      public BaseEncapsulatedKeyRecordRepository keyRepository()
      Returns the value of the keyRepository record component.
      Specified by:
      keyRepository in interface EnvelopePropertyEncryptionProfile
      Returns:
      the value of the keyRepository record component
    • asyncKeyRepository

      public AsyncEncapsulatedKeyRecordRepository asyncKeyRepository()
      Returns the value of the asyncKeyRepository record component.
      Returns:
      the value of the asyncKeyRepository record component
    • cryptoContextRef

      public CryptoContext cryptoContextRef()
      Returns the value of the cryptoContextRef record component.
      Returns:
      the value of the cryptoContextRef record component
    • keyCacheConfigRef

      public CacheConfig keyCacheConfigRef()
      Returns the value of the keyCacheConfigRef record component.
      Returns:
      the value of the keyCacheConfigRef record component
    • keyAliasCacheConfigRef

      public CacheConfig keyAliasCacheConfigRef()
      Returns the value of the keyAliasCacheConfigRef record component.
      Returns:
      the value of the keyAliasCacheConfigRef record component