dev.galasa.framework.spi.IConfidentialTextServiceRegistration 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;

import javax.validation.constraints.NotNull;

/**
 * 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 IConfidentialTextServiceRegistration {

    /**
     * Registers the service with the framework, ensuring only one service is
     * operational at one time.
     * 
     * @param frameworkInitialisation
     * @throws ConfidentialTextException
     */
    void initialise(@NotNull IFrameworkInitialisation frameworkInitialisation) throws ConfidentialTextException;

}