Package org.jenkinsci.plugins.workflow.steps

Class StepEnvironmentContributor

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepEnvironmentContributor

All Implemented Interfaces:

ExtensionPoint

public abstract class StepEnvironmentContributor
extends Object
implements ExtensionPoint

Contributes environment variables to workflow steps.

This extension point can be used to externally add environment variables per workflow step.

Since:

XXX

Author:

Thomas Weißschuh, Amadeus Germany GmbH

See Also:

EnvironmentContributor

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
StepEnvironmentContributor()

Method Summary

Modifier and Type	Method	Description
void	buildEnvironmentFor(StepContext stepContext, EnvVars envs, TaskListener listener)	Contributes environment variables used for a workflow step.

Methods inherited from class java.lang.Object

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

Constructor Detail

StepEnvironmentContributor

public StepEnvironmentContributor()

Method Detail

buildEnvironmentFor

public void buildEnvironmentFor(@NonNull
                                StepContext stepContext,
                                @NonNull
                                EnvVars envs,
                                @NonNull
                                TaskListener listener)
                         throws IOException,
                                InterruptedException

Contributes environment variables used for a workflow step.

This method can be called repeatedly for the same Step, thus the computation of this method needs to be efficient.

This method gets invoked concurrently for multiple Steps that are being built at the same time, so it must be concurrent-safe.

When building environment variables for a build, Jenkins will also invoke EnvironmentContributor.buildEnvironmentFor(hudson.model.Run, EnvVars, TaskListener) and EnvironmentContributor.buildEnvironmentFor(hudson.model.Job, EnvVars, TaskListener) This method only needs to add variables that are scoped to a workflow step.

Parameters:

stepContext - Context of step that's being executed

envs - Partially built environment variable map. Implementation of this method is expected to add additional variables here.

listener - Connected to the build console. Can be used to report errors.

Throws:

IOException

InterruptedException