com.datapipe.jenkins.vault

Class VaultBuildWrapper

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>

hudson.tasks.BuildWrapper

jenkins.tasks.SimpleBuildWrapper

com.datapipe.jenkins.vault.VaultBuildWrapper

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.BuildWrapper>

public class VaultBuildWrapper
extends jenkins.tasks.SimpleBuildWrapper

Sample BuildWrapper.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new VaultBuildWrapper is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields (like vaultUrl) to remember the configuration.

When a build is performed, the SimpleBuildWrapper.preCheckout(AbstractBuild, Launcher, BuildListener) method will be invoked.

Author:

Peter Tierno <ptierno@datapipe.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultBuildWrapper.DescriptorImpl Descriptor for VaultBuildWrapper.

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

jenkins.tasks.SimpleBuildWrapper.Context, jenkins.tasks.SimpleBuildWrapper.Disposer

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

hudson.tasks.BuildWrapper.Environment

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
VaultBuildWrapper(List<VaultSecret> vaultSecrets)

Method Summary

Modifier and Type	Method and Description
hudson.console.ConsoleLogFilter	createLoggerDecorator(hudson.model.Run<?,?> build)
hudson.util.Secret	getAuthToken()
VaultBuildWrapper.DescriptorImpl	getDescriptor()
List<VaultSecret>	getVaultSecrets()
String	getVaultUrl()
void	setAuthToken(String authToken)
void	setUp(jenkins.tasks.SimpleBuildWrapper.Context context, hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.EnvVars initialEnvironment)
void	setVaultUrl(String vaultUrl)

Methods inherited from class jenkins.tasks.SimpleBuildWrapper

decorateLauncher, decorateLogger, getProjectActions, makeBuildVariables, makeSensitiveBuildVariables, preCheckout, runPreCheckout, setUp

Methods inherited from class hudson.tasks.BuildWrapper

all, getProjectAction, setUp

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultBuildWrapper

@DataBoundConstructor
public VaultBuildWrapper(@CheckForNull
                                               List<VaultSecret> vaultSecrets)

Method Detail

setVaultUrl

@DataBoundSetter
public void setVaultUrl(String vaultUrl)

getVaultUrl

public String getVaultUrl()

setAuthToken

@DataBoundSetter
public void setAuthToken(String authToken)

getAuthToken

public hudson.util.Secret getAuthToken()

getVaultSecrets

public List<VaultSecret> getVaultSecrets()

getDescriptor

public VaultBuildWrapper.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.BuildWrapper>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<hudson.tasks.BuildWrapper>

setUp

public void setUp(jenkins.tasks.SimpleBuildWrapper.Context context,
                  hudson.model.Run<?,?> build,
                  hudson.FilePath workspace,
                  hudson.Launcher launcher,
                  hudson.model.TaskListener listener,
                  hudson.EnvVars initialEnvironment)
           throws IOException,
                  InterruptedException

Specified by:

setUp in class jenkins.tasks.SimpleBuildWrapper

Throws:

IOException

InterruptedException

createLoggerDecorator

public hudson.console.ConsoleLogFilter createLoggerDecorator(@Nonnull
                                                             hudson.model.Run<?,?> build)

Overrides:

createLoggerDecorator in class jenkins.tasks.SimpleBuildWrapper