Module dev.orne.config
Package dev.orne.config

Interface ConfigCryptoProvider

All Known Implementing Classes:
AbstractConfigCryptoProvider, DefaultConfigCryptoProvider, PooledConfigCryptoProvider
@API(status=STABLE, since="1.0") public interface ConfigCryptoProvider
Provider of cryptographic transformations for configuration values.
Since:
0.2
Version:
1.0, 2020-04
Author:
(w) Iker Hernaez

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull CryptoProviderEngineBuilder
    builder()
    Creates a new cryptography transformations provider builder.
    String
    decrypt(String value)
    Decrypts the specified encrypted configuration value.
    void
    destroy()
    Destroys all secret information.
    String
    encrypt(String value)
    Encrypts the specified plain configuration value.

  • Method Details

    • builder

      @NotNull static @NotNull CryptoProviderEngineBuilder builder()
      Creates a new cryptography transformations provider builder.
      Returns:
      The provider builder.

    • encrypt

      String encrypt(String value) throws ConfigCryptoProviderException
      Encrypts the specified plain configuration value.
      Parameters:
      value - The plain configuration value
      Returns:
      The encrypted configuration value
      Throws:
      ConfigCryptoProviderException - If an exception occurs during the encryption process

    • decrypt

      String decrypt(String value) throws ConfigCryptoProviderException
      Decrypts the specified encrypted configuration value.
      Parameters:
      value - The encrypted configuration value
      Returns:
      The plain configuration value
      Throws:
      ConfigCryptoProviderException - If an exception occurs during the decryption process

    • destroy

      void destroy()
      Destroys all secret information. Any further call to the instance will throw an IllegalStateException.
      Throws:
      ConfigCryptoProviderException - If an error occurs destroying the secret information.