Package dev.galasa.framework.spi

Interface IConfidentialTextService

public interface IConfidentialTextService
The confidential text services provides a manager with the ability to registered passwords, usernames, keys and other confidnetial texts so that they can be obscured inside logs and outputs.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    registerText(String confidentialString, String comment)
    Regsiters a confidential text on the service.
    String
    removeConfidentialText(String text)
    Removed any number of registered texts from a given log or output.
    void
    shutdown()
    Shutdown the confidential text service

  • Method Details

    • registerText

      void registerText(String confidentialString, String comment)
      Regsiters a confidential text on the service. When any log or output is passed through this service it will then obscure it with a numbered Tag.
      Parameters:
      confidentialString - - the string to be registered.
      comment - - a comment explaining the string.

    • removeConfidentialText

      String removeConfidentialText(String text)
      Removed any number of registered texts from a given log or output.
      Parameters:
      text - - the orginal log ior output.
      Returns:
      -the obscured log or output.

    • shutdown

      void shutdown()
      Shutdown the confidential text service