Class DecryptFileResult

Object
DecryptFileResult
public class DecryptFileResult extends Object

DecryptFileResult

Value object returned by AnkaSecureSdk#decryptFile. It encapsulates:

  • Plaintext payload – Base64‑encoded representation of the decrypted file.
  • Key metadata – the key requested by the caller and the key actually used once server‑side rotation logic is applied.
  • Algorithm negotiated – exact hybrid algorithm selected by the crypto‑engine (e.g. ML‑KEM‑768+A128GCM).
  • Warnings – non‑fatal conditions (usage threshold near, sunset scheduled, etc.) returned by the platform.

Thread‑safety: the class is a simple data carrier with no internal synchronisation. Treat instances as immutable once returned by the SDK and refrain from mutating them across threads.

Since:
1.0.0
Author:
Anka Technologies SDK Team

  • Constructor Details

    • DecryptFileResult

      public DecryptFileResult()

  • Method Details

    • getDecryptedData

      public String getDecryptedData()
      Returns the plaintext payload, Base64‑encoded.
      Returns:
      Base64 string containing the decrypted file contents

    • setDecryptedData

      public void setDecryptedData(String decryptedData)
      Sets the Base64 representation of the plaintext payload. Intended for internal use by the SDK’s mapping layer.
      Parameters:
      decryptedData - Base64‑encoded plaintext (must not be null)

    • getKeyRequested

      public String getKeyRequested()
      Returns:
      the key ID originally requested by the client

    • setKeyRequested

      public void setKeyRequested(String keyRequested)
      Parameters:
      keyRequested - the key ID originally requested by the client

    • getActualKeyUsed

      public String getActualKeyUsed()
      Returns:
      the key ID actually used by the server, or null if identical to keyRequested

    • setActualKeyUsed

      public void setActualKeyUsed(String actualKeyUsed)
      Parameters:
      actualKeyUsed - the key ID effectively used by the server

    • getAlgorithmUsed

      public String getAlgorithmUsed()
      Returns:
      algorithm negotiated by the crypto‑engine

    • setAlgorithmUsed

      public void setAlgorithmUsed(String algorithmUsed)
      Parameters:
      algorithmUsed - algorithm negotiated by the crypto‑engine

    • getWarnings

      public List<String> getWarnings()
      Returns:
      list of non‑fatal warnings, or null/empty if none

    • setWarnings

      public void setWarnings(List<String> warnings)
      Parameters:
      warnings - list of non‑fatal warnings produced by the platform

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object