Package org.jenkinsci.plugins.envinject.model

Class EnvInjectJobPropertyContributor

java.lang.Object

org.jenkinsci.plugins.envinject.model.EnvInjectJobPropertyContributor

All Implemented Interfaces:

ExtensionPoint, Describable<EnvInjectJobPropertyContributor>, Serializable

public abstract class EnvInjectJobPropertyContributor
extends Object
implements ExtensionPoint, Describable<EnvInjectJobPropertyContributor>, Serializable

Author:

Gregory Boissinot

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
EnvInjectJobPropertyContributor()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<EnvInjectJobPropertyContributor,EnvInjectJobPropertyContributorDescriptor>	all()
void	contributeEnvVarsToRun(Run<?,?> run, TaskListener listener, Map<String,String> envVars)	Contributes environment variables to the run.
Descriptor<EnvInjectJobPropertyContributor>	getDescriptor()
Map<String,String>	getEnvVars(AbstractBuild build, TaskListener listener)	Deprecated. Use contributeEnvVarsToRun(hudson.model.Run, hudson.model.TaskListener, java.util.Map)
abstract void	init()	Call it in order to fill in fields of the type

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvInjectJobPropertyContributor

public EnvInjectJobPropertyContributor()

Method Detail

init

public abstract void init()

Call it in order to fill in fields of the type

getEnvVars

@Deprecated
public Map<String,String> getEnvVars(@NonNull
                                           AbstractBuild build,
                                           @NonNull
                                           TaskListener listener)
                                    throws org.jenkinsci.lib.envinject.EnvInjectException

Deprecated.

Use contributeEnvVarsToRun(hudson.model.Run, hudson.model.TaskListener, java.util.Map)

Throws:

org.jenkinsci.lib.envinject.EnvInjectException

contributeEnvVarsToRun

@NonNull
public void contributeEnvVarsToRun(@NonNull
                                   Run<?,?> run,
                                   @NonNull
                                   TaskListener listener,
                                   @NonNull
                                   Map<String,String> envVars)
                            throws org.jenkinsci.lib.envinject.EnvInjectException

Contributes environment variables to the run.

Parameters:

run - Run

listener - Log listener

envVars - Target collection

Throws:

org.jenkinsci.lib.envinject.EnvInjectException - Environment injection error

Since:

2.1

getDescriptor

public Descriptor<EnvInjectJobPropertyContributor> getDescriptor()

Specified by:

getDescriptor in interface Describable<EnvInjectJobPropertyContributor>

all

public static DescriptorExtensionList<EnvInjectJobPropertyContributor,EnvInjectJobPropertyContributorDescriptor> all()