Package io.jenkins.plugins.configsplice

Class ConfigSubstitutionStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

io.jenkins.plugins.configsplice.ConfigSubstitutionStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class ConfigSubstitutionStep
extends org.jenkinsci.plugins.workflow.steps.Step

The configSubstitution Pipeline step (SRS section 4).

 def result = configSubstitution(
     targets: [[files: ['**' + '/web.config'], format: 'xml',
                substitutions: [[path: 'appSettings.ApiUrl', value: 'https://production.com']]]]
 )
 echo "Changed ${result['filesChanged']} file(s)"
 

The step resolves credentials on the controller, where the Run context is available, then hands a fully resolved request to the agent that owns the workspace. It returns a value-free map of plain JDK collections so that a sandboxed Pipeline can read it without Script Approval.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigSubstitutionStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ConfigSubstitutionStep(List<TargetGroup> targets)

Method Summary

Modifier and Type	Method	Description
String	getMissingPathBehavior()
String	getNoMatchBehavior()
List<TargetGroup>	getTargets()
boolean	isAcknowledgeSecretLifecycle()
boolean	isDryRun()
void	setAcknowledgeSecretLifecycle(boolean acknowledgeSecretLifecycle)
void	setDryRun(boolean dryRun)
void	setMissingPathBehavior(String missingPathBehavior)
void	setNoMatchBehavior(String noMatchBehavior)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigSubstitutionStep

@DataBoundConstructor
public ConfigSubstitutionStep(@NonNull
 List<TargetGroup> targets)

Method Details

getTargets

@NonNull
public List<TargetGroup> getTargets()

isDryRun

public boolean isDryRun()

setDryRun

@DataBoundSetter
public void setDryRun(boolean dryRun)

getNoMatchBehavior

@NonNull
public String getNoMatchBehavior()

setNoMatchBehavior

@DataBoundSetter
public void setNoMatchBehavior(@CheckForNull
 String noMatchBehavior)

getMissingPathBehavior

@NonNull
public String getMissingPathBehavior()

setMissingPathBehavior

@DataBoundSetter
public void setMissingPathBehavior(@CheckForNull
 String missingPathBehavior)

isAcknowledgeSecretLifecycle

public boolean isAcknowledgeSecretLifecycle()

setAcknowledgeSecretLifecycle

@DataBoundSetter
public void setAcknowledgeSecretLifecycle(boolean acknowledgeSecretLifecycle)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step