Package com.atlassian.secrets.api

Interface SecretStore

@Deprecated public interface SecretStore
Deprecated.
4.0.0
An API for storing and retrieving secret data. The corresponding Implementation should provide a public empty constructor, which will be called by SecretStoreProvider.getInstance(String) using reflection
Since:
3.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    get(String encryptedData)
    Deprecated.
    Used to load secrets saved by store(String)
    String
    store(String plainTextData)
    Deprecated.
    Used to store data in plain text.

  • Method Details

    • store

      String store(String plainTextData)
      Deprecated.
      Used to store data in plain text.
      Parameters:
      plainTextData - data in plain text which should be stored securely
      Returns:
      a string representing the stored secret to be saved in the configuration file
      Throws:
      SecretStoreException - in the case of any errors during storage

    • get

      String get(String encryptedData)
      Deprecated.
      Used to load secrets saved by store(String)
      Parameters:
      encryptedData - data which has been stored by using store(String)
      Returns:
      plain text data for the supplied encrypted data
      Throws:
      SecretStoreException - in the case of any errors during retrieval