javaposse.jobdsl.plugin

Class ExecuteDslScripts

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

javaposse.jobdsl.plugin.ExecuteDslScripts

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class ExecuteDslScripts
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

This Builder keeps a list of job DSL scripts, and when prompted, executes these to create / update Jenkins jobs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecuteDslScripts.ScriptLocation Deprecated.

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

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ExecuteDslScripts()
ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation) Deprecated.
ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation, boolean ignoreExisting, javaposse.jobdsl.plugin.RemovedJobAction removedJobAction) Deprecated.
ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation, boolean ignoreExisting, javaposse.jobdsl.plugin.RemovedJobAction removedJobAction, LookupStrategy lookupStrategy) Deprecated.
ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation, boolean ignoreExisting, javaposse.jobdsl.plugin.RemovedJobAction removedJobAction, javaposse.jobdsl.plugin.RemovedViewAction removedViewAction, LookupStrategy lookupStrategy) Deprecated.
ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation, boolean ignoreExisting, javaposse.jobdsl.plugin.RemovedJobAction removedJobAction, javaposse.jobdsl.plugin.RemovedViewAction removedViewAction, LookupStrategy lookupStrategy, java.lang.String additionalClasspath) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalClasspath()
LookupStrategy	getLookupStrategy()
java.util.Collection<? extends hudson.model.Action>	getProjectActions(hudson.model.AbstractProject<?,?> project)
javaposse.jobdsl.plugin.RemovedJobAction	getRemovedJobAction()
javaposse.jobdsl.plugin.RemovedViewAction	getRemovedViewAction()
ExecuteDslScripts.ScriptLocation	getScriptLocation() Deprecated.
java.lang.String	getScriptText()
java.lang.String	getTargets()
java.lang.Boolean	getUseScriptText()
boolean	isFailOnMissingPlugin()
boolean	isIgnoreExisting()
boolean	isIgnoreMissingFiles()
boolean	isUnstableOnDeprecation()
boolean	isUsingScriptText()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Runs every job DSL script provided in the plugin configuration, which results in new / updated Jenkins jobs.
void	setAdditionalClasspath(java.lang.String additionalClasspath)
void	setFailOnMissingPlugin(boolean failOnMissingPlugin)
void	setIgnoreExisting(boolean ignoreExisting)
void	setIgnoreMissingFiles(boolean ignoreMissingFiles)
void	setLookupStrategy(LookupStrategy lookupStrategy)
void	setRemovedJobAction(javaposse.jobdsl.plugin.RemovedJobAction removedJobAction)
void	setRemovedViewAction(javaposse.jobdsl.plugin.RemovedViewAction removedViewAction)
void	setScriptLocation(ExecuteDslScripts.ScriptLocation scriptLocation) Deprecated.
void	setScriptText(java.lang.String scriptText)
void	setTargets(java.lang.String targets)
void	setUnstableOnDeprecation(boolean unstableOnDeprecation)
void	setUseScriptText(java.lang.Boolean value)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, 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, getRequiredMonitorService, perform, prebuild

Constructor Detail

ExecuteDslScripts

@DataBoundConstructor
public ExecuteDslScripts()

ExecuteDslScripts

@Deprecated
public ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation)

Deprecated.

ExecuteDslScripts

@Deprecated
public ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation,
                                      boolean ignoreExisting,
                                      javaposse.jobdsl.plugin.RemovedJobAction removedJobAction,
                                      javaposse.jobdsl.plugin.RemovedViewAction removedViewAction,
                                      LookupStrategy lookupStrategy,
                                      java.lang.String additionalClasspath)

Deprecated.

ExecuteDslScripts

@Deprecated
public ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation,
                                      boolean ignoreExisting,
                                      javaposse.jobdsl.plugin.RemovedJobAction removedJobAction,
                                      LookupStrategy lookupStrategy)

Deprecated.

ExecuteDslScripts

@Deprecated
public ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation,
                                      boolean ignoreExisting,
                                      javaposse.jobdsl.plugin.RemovedJobAction removedJobAction)

Deprecated.

ExecuteDslScripts

@Deprecated
public ExecuteDslScripts(ExecuteDslScripts.ScriptLocation scriptLocation,
                                      boolean ignoreExisting,
                                      javaposse.jobdsl.plugin.RemovedJobAction removedJobAction,
                                      javaposse.jobdsl.plugin.RemovedViewAction removedViewAction,
                                      LookupStrategy lookupStrategy)

Deprecated.

Method Detail

getTargets

public java.lang.String getTargets()

setTargets

@DataBoundSetter
public void setTargets(java.lang.String targets)

getScriptText

public java.lang.String getScriptText()

setScriptText

@DataBoundSetter
public void setScriptText(java.lang.String scriptText)

isUsingScriptText

public boolean isUsingScriptText()

getUseScriptText

public java.lang.Boolean getUseScriptText()

setUseScriptText

@DataBoundSetter
public void setUseScriptText(java.lang.Boolean value)

isIgnoreMissingFiles

public boolean isIgnoreMissingFiles()

setIgnoreMissingFiles

@DataBoundSetter
public void setIgnoreMissingFiles(boolean ignoreMissingFiles)

isIgnoreExisting

public boolean isIgnoreExisting()

setIgnoreExisting

@DataBoundSetter
public void setIgnoreExisting(boolean ignoreExisting)

isFailOnMissingPlugin

public boolean isFailOnMissingPlugin()

setFailOnMissingPlugin

@DataBoundSetter
public void setFailOnMissingPlugin(boolean failOnMissingPlugin)

isUnstableOnDeprecation

public boolean isUnstableOnDeprecation()

setUnstableOnDeprecation

@DataBoundSetter
public void setUnstableOnDeprecation(boolean unstableOnDeprecation)

getRemovedJobAction

public javaposse.jobdsl.plugin.RemovedJobAction getRemovedJobAction()

setRemovedJobAction

@DataBoundSetter
public void setRemovedJobAction(javaposse.jobdsl.plugin.RemovedJobAction removedJobAction)

getRemovedViewAction

public javaposse.jobdsl.plugin.RemovedViewAction getRemovedViewAction()

setRemovedViewAction

@DataBoundSetter
public void setRemovedViewAction(javaposse.jobdsl.plugin.RemovedViewAction removedViewAction)

getLookupStrategy

public LookupStrategy getLookupStrategy()

setLookupStrategy

@DataBoundSetter
public void setLookupStrategy(LookupStrategy lookupStrategy)

getAdditionalClasspath

public java.lang.String getAdditionalClasspath()

setAdditionalClasspath

@DataBoundSetter
public void setAdditionalClasspath(java.lang.String additionalClasspath)

getProjectActions

public java.util.Collection<? extends hudson.model.Action> getProjectActions(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectActions in interface hudson.tasks.BuildStep

Overrides:

getProjectActions in class hudson.tasks.BuildStepCompatibilityLayer

getScriptLocation

@Deprecated
public ExecuteDslScripts.ScriptLocation getScriptLocation()

Deprecated.

setScriptLocation

@DataBoundSetter
 @Deprecated
public void setScriptLocation(ExecuteDslScripts.ScriptLocation scriptLocation)

Deprecated.

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> run,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws java.lang.InterruptedException,
                    java.io.IOException

Runs every job DSL script provided in the plugin configuration, which results in new / updated Jenkins jobs. The created / updated jobs are reported in the build result.

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

java.lang.InterruptedException

java.io.IOException