Package com.unboundid.directory.sdk.common.types

Interface EncryptionSettingsDefinition

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Set<java.lang.String> getAllIDStrings()
      Retrieves a set of all identifiers that may be used to reference this encryption settings definition, including the primary identifier and any legacy identifiers that may have been used for this definition over time.
      java.lang.String getCipherTransformation()
      Retrieves the cipher transformation used for this encryption settings definition.
      java.util.Date getCreateTime()
      Retrieves the time that this encryption settings definition was created, if available.
      java.lang.String getDescription()
      Retrieves a description for this encryption settings definition, if available.
      int getGCMTagLengthBits()
      Retrieves the length of the GCM authentication tag in bits, if applicable.
      int getInitializationVectorLengthBytes()
      Retrieves the length in bytes of the initialization vector that will be used with this encryption settings definition.
      java.lang.String getKeyFactoryAlgorithm()
      Retrieves the name of the key factory algorithm used to generate the key for this encryption settings definition.
      int getKeyIterationCount()
      Retrieves the iteration count provided to the key factory algorithm in the course of generating the encryption key.
      int getKeyLengthBits()
      Retrieves the length in bits of the key for this encryption settings object.
      int getKeySaltLengthBytes()
      Retrieves the size in bytes of the salt provided to the key factory algorithm in the course of generating the encryption key.
      java.lang.String getPrimaryIDString()
      Retrieves a string representation of the primary identifier for this encryption settings definition.
      java.lang.String toString()
      Retrieves a string representation of this encryption settings definition.

    • Method Detail

      • getPrimaryIDString

        java.lang.String getPrimaryIDString()
        Retrieves a string representation of the primary identifier for this encryption settings definition.
        Returns:
        A string representation of the primary identifier for this encryption settings definition.

      • getAllIDStrings

        java.util.Set<java.lang.String> getAllIDStrings()
        Retrieves a set of all identifiers that may be used to reference this encryption settings definition, including the primary identifier and any legacy identifiers that may have been used for this definition over time.
        Returns:
        A set of all identifiers that may be used to reference this encryption settings definition.

      • getCipherTransformation

        java.lang.String getCipherTransformation()
        Retrieves the cipher transformation used for this encryption settings definition.
        Returns:
        The cipher transformation used for this encryption settings definition.

      • getGCMTagLengthBits

        int getGCMTagLengthBits()
        Retrieves the length of the GCM authentication tag in bits, if applicable.
        Returns:
        The length of the GCM authentication tag in bits, or -1 if it does not apply to this encryption settings definition.

      • getKeyFactoryAlgorithm

        java.lang.String getKeyFactoryAlgorithm()
        Retrieves the name of the key factory algorithm used to generate the key for this encryption settings definition.
        Returns:
        The name of the key factory algorithm used to generate the key for this encryption settings definition.

      • getKeyIterationCount

        int getKeyIterationCount()
        Retrieves the iteration count provided to the key factory algorithm in the course of generating the encryption key.
        Returns:
        The iteration count provided to the key factory algorithm in the course of generating the encryption key.

      • getKeySaltLengthBytes

        int getKeySaltLengthBytes()
        Retrieves the size in bytes of the salt provided to the key factory algorithm in the course of generating the encryption key.
        Returns:
        The size in bytes of the salt provided to the key factory algorithm in the course of generating the encryption key.

      • getInitializationVectorLengthBytes

        int getInitializationVectorLengthBytes()
        Retrieves the length in bytes of the initialization vector that will be used with this encryption settings definition.
        Returns:
        The length in bits of the initialization vector that will be used with this encryption settings definition.

      • getKeyLengthBits

        int getKeyLengthBits()
        Retrieves the length in bits of the key for this encryption settings object.
        Returns:
        The length in bits of the key for this encryption settings object.

      • getCreateTime

        java.util.Date getCreateTime()
        Retrieves the time that this encryption settings definition was created, if available.
        Returns:
        The time that this encryption settings definition was created, or null if that is not available (because the definition was created before the create timestamp was recorded).

      • getDescription

        java.lang.String getDescription()
        Retrieves a description for this encryption settings definition, if available.
        Returns:
        A description for this encryption settings definition, or null if no description is available.

      • toString

        java.lang.String toString()
        Retrieves a string representation of this encryption settings definition.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this encryption settings definition.