Package com.atlassian.secrets.api

Interface SecretService.SecretServiceManagement

Enclosing interface:
SecretService
public static interface SecretService.SecretServiceManagement
An API for managing the SecretService.
Since:
5.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<SecretKey>
    getInactiveKeys()
    Retrieves a set of inactive AES keys from the key directory.
    void
    reloadConfiguration()
    Ensures that the current SecretService configuration is in sync with the configuration in the persistent data storage (secrets-config.yaml)
    RotationStatus
    rotateAESKey()
    Rotates the AES encryption key if applicable to the current SecretService configuration.

  • Method Details

    • rotateAESKey

      RotationStatus rotateAESKey() throws SecretServiceException
      Rotates the AES encryption key if applicable to the current SecretService configuration.
      Returns:
      RotationStatus response providing details of the rotation state to the caller
      Throws:
      SecretServiceException - Will be thrown if there is an error or the SecretService is not configured to use AES (and key rotation is not applicable)

    • reloadConfiguration

      void reloadConfiguration() throws SecretServiceException
      Ensures that the current SecretService configuration is in sync with the configuration in the persistent data storage (secrets-config.yaml)
      Throws:
      SecretServiceException - Will be thrown if there is an error reading, parsing or applying the configuration to the SecretService.

    • getInactiveKeys

      Set<SecretKey> getInactiveKeys() throws SecretServiceException
      Retrieves a set of inactive AES keys from the key directory.
      Returns:
      A set of inactive AES SecretKey record.
      Throws:
      SecretServiceException - If an error occurs while reading the key directory or the secret configuration.