Interface IPromptConnectionExportSpec

public interface IPromptConnectionExportSpec
Specification for exporting a prompt connection, including the prompt connection identifier and an optional password for encryption.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    char[]
    getPassword()
    Gets the password to encrypt the exported prompt connection data.
    @NotNull PromptObjectIdentifier
    getPromptConnectionId()
    Gets the identifier of the prompt connection to export.
    default boolean
    isEncrypted()
    Checks if the export should be encrypted based on the presence of a password.

  • Method Details

    • getPassword

      char[] getPassword()
      Gets the password to encrypt the exported prompt connection data. May be null or empty, in which case no encryption is applied.

      ATTENTION: No password should only be used when the exported data is part of an encrypted archive (e.g. encrypted project export).

      Returns:
      The password as a character array, or null/empty if no encryption should be applied.

    • getPromptConnectionId

      @NotNull @NotNull PromptObjectIdentifier getPromptConnectionId()
      Gets the identifier of the prompt connection to export.
      Returns:
      The identifier of the prompt connection to export. Never null.

    • isEncrypted

      default boolean isEncrypted()
      Checks if the export should be encrypted based on the presence of a password.
      Returns:
      true if a non-empty password was set, false otherwise.