Package com.unboundid.directory.sdk.ds.types

Interface LDIFExportTaskProperties

  • public interface LDIFExportTaskProperties
    This information may be used to obtain information about an LDIF export task that was processed by the server.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getBackendID()
      Retrieves the backend ID for the backend from which the export was generated.
      java.lang.String getEncryptionPassphrase()
      Retrieves the passphrase that was used to encrypt the LDIF file, if applicable.
      java.lang.String getEncryptionSettingsDefinitionID()
      Retrieves the ID of the encryption settings definition that was used to encrypt the LDIF file, if applicable.
      java.io.File getOutputFile()
      Retrieves the output file to which the data was exported.
      java.lang.String getTaskID()
      Retrieves the task ID for the associated LDIF export task.
      boolean isCompressed()
      Indicates whether the LDIF export is GZIP-compressed.
      boolean isEncrypted()
      Indicates whether the LDIF export is encrypted.
      java.lang.String toString()
      Retrieves a string representation of this LDIF export task properties object.

    • Method Detail

      • getTaskID

        @NotNull
java.lang.String getTaskID()
        Retrieves the task ID for the associated LDIF export task.
        Returns:
        The task ID for the associated LDIF export task.

      • getOutputFile

        @NotNull
java.io.File getOutputFile()
        Retrieves the output file to which the data was exported.
        Returns:
        The output file to which the data was exported.

      • getBackendID

        @NotNull
java.lang.String getBackendID()
        Retrieves the backend ID for the backend from which the export was generated.
        Returns:
        The backend ID for the backend from which the export was generated.

      • isCompressed

        boolean isCompressed()
        Indicates whether the LDIF export is GZIP-compressed.
        Returns:
        true if the LDIF export is GZIP-compressed, or false if not.

      • isEncrypted

        boolean isEncrypted()
        Indicates whether the LDIF export is encrypted.
        Returns:
        true if the LDIF export is encrypted, or false if not.

      • getEncryptionSettingsDefinitionID

        @Nullable
java.lang.String getEncryptionSettingsDefinitionID()
        Retrieves the ID of the encryption settings definition that was used to encrypt the LDIF file, if applicable.
        Returns:
        The ID of the encryption settings definition that was used to encrypt the LDIF file, or null if the LDIF file was not encrypted or if it was encrypted with a passphrase rather than an encryption settings definition.

      • getEncryptionPassphrase

        @Nullable
java.lang.String getEncryptionPassphrase()
        Retrieves the passphrase that was used to encrypt the LDIF file, if applicable.
        Returns:
        The passphrase that was used to encrypt the LDIF file, or null if the LDIF file was not encrypted or if it was encrypted with an encryption settings definition rather than a specified passphrase.

      • toString

        @NotNull
java.lang.String toString()
        Retrieves a string representation of this LDIF export task properties object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this LDIF export task properties object.