Package com.michelin.cio.hudson.plugins.maskpasswords

Class MaskPasswordsBuildWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<BuildWrapper>

hudson.tasks.BuildWrapper

jenkins.tasks.SimpleBuildWrapper

com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper

All Implemented Interfaces:

ExtensionPoint, Describable<BuildWrapper>

public final class MaskPasswordsBuildWrapper
extends SimpleBuildWrapper

Build wrapper that alters the console so that passwords don't get displayed.

Author:

Romain Seguy (http://openromain.blogspot.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MaskPasswordsBuildWrapper.ConverterImpl	We need this converter to handle marshalling/unmarshalling of the build wrapper data: Relying on the default mechanism doesn't make it (because Secret doesn't have the DataBoundConstructor annotation).
static class	MaskPasswordsBuildWrapper.DescriptorImpl
static class	MaskPasswordsBuildWrapper.VarMaskRegex	Represents regexes defined by users in their jobs.
static class	MaskPasswordsBuildWrapper.VarPasswordPair	Represents name/password entries defined by users in their jobs.

Nested classes/interfaces inherited from class jenkins.tasks.SimpleBuildWrapper

SimpleBuildWrapper.Context, SimpleBuildWrapper.Disposer

Nested classes/interfaces inherited from class hudson.tasks.BuildWrapper

BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
MaskPasswordsBuildWrapper(List<MaskPasswordsBuildWrapper.VarPasswordPair> varPasswordPairs)
MaskPasswordsBuildWrapper(List<MaskPasswordsBuildWrapper.VarPasswordPair> varPasswordPairs, List<MaskPasswordsConfig.VarMaskRegexEntry> varMaskRegexes)

Method Summary

Modifier and Type	Method	Description
ConsoleLogFilter	createLoggerDecorator(Run<?,?> build)
List<MaskPasswordsConfig.VarMaskRegexEntry>	getVarMaskRegexes()
List<MaskPasswordsBuildWrapper.VarPasswordPair>	getVarPasswordPairs()
void	makeBuildVariables(AbstractBuild build, Map<String,String> variables)	Contributes the passwords defined by the user as variables that can be reused from build steps (and other places).
void	makeSensitiveBuildVariables(AbstractBuild build, Set<String> sensitiveVariables)
boolean	requiresWorkspace()
void	setUp(SimpleBuildWrapper.Context context, Run<?,?> build, TaskListener listener, EnvVars initialEnvironment)

Methods inherited from class jenkins.tasks.SimpleBuildWrapper

createContext, decorateLauncher, decorateLogger, getProjectActions, preCheckout, runPreCheckout, setUp, setUp

Methods inherited from class hudson.tasks.BuildWrapper

all, getProjectAction, setUp

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaskPasswordsBuildWrapper

@DataBoundConstructor
public MaskPasswordsBuildWrapper(List<MaskPasswordsBuildWrapper.VarPasswordPair> varPasswordPairs,
                                 List<MaskPasswordsConfig.VarMaskRegexEntry> varMaskRegexes)

MaskPasswordsBuildWrapper

public MaskPasswordsBuildWrapper(List<MaskPasswordsBuildWrapper.VarPasswordPair> varPasswordPairs)

Method Detail

createLoggerDecorator

public ConsoleLogFilter createLoggerDecorator(Run<?,?> build)

Overrides:

createLoggerDecorator in class SimpleBuildWrapper

requiresWorkspace

public boolean requiresWorkspace()

Overrides:

requiresWorkspace in class SimpleBuildWrapper

makeBuildVariables

public void makeBuildVariables(AbstractBuild build,
                               Map<String,String> variables)

Contributes the passwords defined by the user as variables that can be reused from build steps (and other places).

Overrides:

makeBuildVariables in class SimpleBuildWrapper

makeSensitiveBuildVariables

public void makeSensitiveBuildVariables(AbstractBuild build,
                                        Set<String> sensitiveVariables)

Overrides:

makeSensitiveBuildVariables in class SimpleBuildWrapper

setUp

public void setUp(SimpleBuildWrapper.Context context,
                  Run<?,?> build,
                  TaskListener listener,
                  EnvVars initialEnvironment)
           throws IOException,
                  InterruptedException

Overrides:

setUp in class SimpleBuildWrapper

Throws:

IOException

InterruptedException

getVarPasswordPairs

public List<MaskPasswordsBuildWrapper.VarPasswordPair> getVarPasswordPairs()

getVarMaskRegexes

public List<MaskPasswordsConfig.VarMaskRegexEntry> getVarMaskRegexes()