dev.galasa.framework.spi.IConfidentialTextService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.framework Show documentation

A Galasa project

There is a newer version: 0.37.0

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.framework.spi;

/**
 * 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.
 * 
 *  
 */
public interface IConfidentialTextService {

    /**
     * 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.
     * 
     * @param confidentialString - the string to be registered.
     * @param comment            - a comment explaining the string.
     */
    void registerText(String confidentialString, String comment);

    /**
     * Removed any number of registered texts from a given log or output.
     * 
     * @param text - the orginal log ior output.
     * @return -the obscured log or output.
     */
    String removeConfidentialText(String text);

    /**
     * Shutdown the confidential text service
     */
    void shutdown();

}