Package org.jenkinsci.plugins.ansible

Class AnsibleVaultBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.ansible.AnsibleVaultBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class AnsibleVaultBuilder
extends Builder
implements SimpleBuildStep

A builder which wraps an Ansible vault invocation.

Author:

Michael Cresswell

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AnsibleVaultBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields

Modifier and Type	Field	Description
String	action
String	ansibleName
String	content
String	input
String	newVaultCredentialsId
String	output
String	vaultCredentialsId
String	vaultTmpPath

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
AnsibleVaultBuilder()

Method Summary

Modifier and Type	Method	Description
BuildStepMonitor	getRequiredMonitorService()
void	perform(Run<?,?> run, FilePath ws, Launcher launcher, TaskListener listener)
void	perform(Run<?,?> run, Node node, FilePath ws, Launcher launcher, TaskListener listener, EnvVars envVars)
void	setAction(String action)
void	setAnsibleName(String ansibleName)
void	setContent(String content)
void	setInput(String input)
void	setNewVaultCredentialsId(String newVaultCredentialsId)
void	setOutput(String output)
void	setVaultCredentialsId(String vaultCredentialsId)
void	setVaultTmpPath(String vaultTmpPath)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Field Details

ansibleName

public String ansibleName

action

public String action

vaultCredentialsId

public String vaultCredentialsId

newVaultCredentialsId

public String newVaultCredentialsId

vaultTmpPath

public String vaultTmpPath

content

public String content

input

public String input

output

public String output

Constructor Details

AnsibleVaultBuilder

@DataBoundConstructor
public AnsibleVaultBuilder()

Method Details

setAnsibleName

@DataBoundSetter
public void setAnsibleName(String ansibleName)

setAction

@DataBoundSetter
public void setAction(String action)

setVaultCredentialsId

@DataBoundSetter
public void setVaultCredentialsId(String vaultCredentialsId)

setNewVaultCredentialsId

@DataBoundSetter
public void setNewVaultCredentialsId(String newVaultCredentialsId)

setVaultTmpPath

@DataBoundSetter
public void setVaultTmpPath(String vaultTmpPath)

setContent

@DataBoundSetter
public void setContent(String content)

setInput

@DataBoundSetter
public void setInput(String input)

setOutput

@DataBoundSetter
public void setOutput(String output)

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath ws,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 Node node,
 @NonNull
 FilePath ws,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener,
 EnvVars envVars)
             throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

Overrides:

getRequiredMonitorService in class Builder