com.gradle.develocity.agent.maven.api.scan.BuildScanDataObfuscation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of develocity-maven-extension Show documentation

Maven extension for Develocity installations that provides Build Insights, Build Caching, Predictive Test Selection, and Test Distribution for Maven builds. Alternatively, Build Insights can be captured and viewed for free at scans.gradle.com and Build Caching can be used for free locally. See https://gradle.com for more information on Develocity.

There is a newer version: 1.23

Show newest version

package com.gradle.develocity.agent.maven.api.scan;

import java.net.InetAddress;
import java.util.List;
import java.util.function.Function;

/**
 * Allows registering functions for obfuscating certain identifying information within build scans.
 *
 * @see BuildScanApi#getObfuscation()
 */
public interface BuildScanDataObfuscation {

    /**
     * Registers a function to transform the username captured.
     * 
     * The function receives the username that would be captured,
     * and should return the username that will be captured.
     * 

     * The received username may be null,
     * and the function may return a null value.
     *
     * @param obfuscator the function to obfuscate the username
     */
    void username(Function obfuscator);

    /**
     * Registers a function to transform the local hostname and public hostname captured.
     * 

     * The function receives the hostname that would be captured,
     * and should return the hostname that will be captured.
     * 

     * The received hostname may be null,
     * and the function may return a null value.
     *
     * @param obfuscator the function to obfuscate the hostname
     */
    void hostname(Function obfuscator);

    /**
     * Registers a function used to transform the IP addresses captured.
     * 

     * The function receives a list of {@link InetAddress} that would be captured,
     * and should return the list of {@link String} that will be captured.
     * 

     * The received list may be null or empty,
     * and the function may return a null or empty list,
     * but may not return a list with a null element.
     *
     * @param obfuscator the function to obfuscate the IP addresses
     */
    void ipAddresses(Function, ? extends List> obfuscator);

    /**
     * Registers a function to transform the names of external processes captured when resource usage capturing is enabled.
     * 

     * An external process is a process running on the same machine as the build, that is not the build process itself, nor a descendant process of the build process.
     * The function receives an external process name that would be captured,
     * and should return the external process name that will be captured.
     * 
     * The received process name may not be null,
     * and the function may not return a null value.
     *
     * @param obfuscator the function to obfuscate the external process names
     * @since 1.22
     */
    void externalProcessName(Function obfuscator);

}