Package io.wcm.devops.conga.generator.spi

Interface ValueEncryptionPlugin

All Superinterfaces:
Plugin
public interface ValueEncryptionPlugin extends Plugin
Encrypts a sensitive configuration parameter value.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    encrypt(String parameterName, Object value, ValueEncryptionContext context)
    Encrypt value.
    boolean
    isEnabled()
    When a value needs to be encrypted, the first enabled encryption plugin is used.

    Methods inherited from interface io.wcm.devops.conga.generator.spi.Plugin

    getName

  • Method Details

    • isEnabled

      boolean isEnabled()
      When a value needs to be encrypted, the first enabled encryption plugin is used. Via this method plugin implementations can report whether they are configured properly and can be used.
      Returns:
      true if Encryption plugin is configured properly.

    • encrypt

      Object encrypt(String parameterName, Object value, ValueEncryptionContext context)
      Encrypt value.
      Parameters:
      parameterName - Parameter name
      value - Unencrypted value
      context - Context
      Returns:
      Encrypted value.
      Throws:
      UnsupportedOperationException - when the plugin is not enabled.