javaposse.jobdsl.plugin

Class JenkinsJobManagement

java.lang.Object

javaposse.jobdsl.dsl.AbstractJobManagement

javaposse.jobdsl.plugin.JenkinsJobManagement

All Implemented Interfaces:

groovy.lang.GroovyObject, javaposse.jobdsl.dsl.JobManagement

public class JenkinsJobManagement
extends javaposse.jobdsl.dsl.AbstractJobManagement

Manages Jenkins jobs, providing facilities to retrieve and create / update.

Field Summary

Fields inherited from interface javaposse.jobdsl.dsl.JobManagement

NO_VALUE

Constructor Summary

Constructors

Constructor and Description
JenkinsJobManagement(java.io.PrintStream outputLogger, java.util.Map<java.lang.String,?> envVars, java.io.File workspace)
JenkinsJobManagement(java.io.PrintStream outputLogger, java.util.Map<java.lang.String,?> envVars, hudson.model.Run<?,?> run, hudson.FilePath workspace, LookupStrategy lookupStrategy)

Method Summary

Modifier and Type	Method and Description
groovy.util.Node	callExtension(java.lang.String name, javaposse.jobdsl.dsl.Item item, java.lang.Class<? extends javaposse.jobdsl.dsl.ExtensibleContext> contextType, java.lang.Object... args)
boolean	createOrUpdateConfig(javaposse.jobdsl.dsl.Item dslItem, boolean ignoreExisting)
void	createOrUpdateUserContent(javaposse.jobdsl.dsl.UserContent userContent, boolean ignoreExisting)
void	createOrUpdateView(java.lang.String path, java.lang.String config, boolean ignoreExisting)
java.lang.String	getConfig(java.lang.String path)
java.util.Map<java.lang.String,java.lang.Object>	getParameters()
java.util.Set<java.lang.String>	getPermissions(java.lang.String descriptorId)
java.lang.Integer	getVSphereCloudHash(java.lang.String name)
boolean	isMinimumCoreVersion(java.lang.String version)
boolean	isMinimumPluginVersionInstalled(java.lang.String pluginShortName, java.lang.String version)
protected void	logDeprecationWarning(java.lang.String subject, java.lang.String details)
void	logPluginDeprecationWarning(java.lang.String pluginShortName, java.lang.String minimumVersion)
void	queueJob(java.lang.String path)
java.lang.String	readFileInWorkspace(java.lang.String relLocation)
java.lang.String	readFileInWorkspace(java.lang.String jobName, java.lang.String relLocation)
void	renameJobMatching(java.lang.String previousNames, java.lang.String destination)
void	requireMinimumCoreVersion(java.lang.String version)
void	requireMinimumPluginVersion(java.lang.String pluginShortName, java.lang.String version)
void	requireMinimumPluginVersion(java.lang.String pluginShortName, java.lang.String version, boolean failIfMissing)
void	requirePlugin(java.lang.String pluginShortName)
void	requirePlugin(java.lang.String pluginShortName, boolean failIfMissing)
void	setFailOnMissingPlugin(boolean failOnMissingPlugin)
java.io.InputStream	streamFileInWorkspace(java.lang.String relLocation)

Methods inherited from class javaposse.jobdsl.dsl.AbstractJobManagement

getMetaClass, getOutputStream, getProperty, invokeMethod, logDeprecationWarning, logDeprecationWarning, logDeprecationWarning, logWarning, logWarning, setMetaClass, setProperty, validateConfigArg, validateNameArg, validateUpdateArgs

Methods inherited from class java.lang.Object

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

Constructor Detail

JenkinsJobManagement

public JenkinsJobManagement(java.io.PrintStream outputLogger,
                            java.util.Map<java.lang.String,?> envVars,
                            hudson.model.Run<?,?> run,
                            hudson.FilePath workspace,
                            LookupStrategy lookupStrategy)

JenkinsJobManagement

public JenkinsJobManagement(java.io.PrintStream outputLogger,
                            java.util.Map<java.lang.String,?> envVars,
                            java.io.File workspace)

Method Detail

setFailOnMissingPlugin

public void setFailOnMissingPlugin(boolean failOnMissingPlugin)

getConfig

public java.lang.String getConfig(java.lang.String path)
                           throws javaposse.jobdsl.dsl.JobConfigurationNotFoundException

Throws:

javaposse.jobdsl.dsl.JobConfigurationNotFoundException

createOrUpdateConfig

public boolean createOrUpdateConfig(javaposse.jobdsl.dsl.Item dslItem,
                                    boolean ignoreExisting)
                             throws javaposse.jobdsl.dsl.NameNotProvidedException

Throws:

javaposse.jobdsl.dsl.NameNotProvidedException

createOrUpdateView

public void createOrUpdateView(java.lang.String path,
                               java.lang.String config,
                               boolean ignoreExisting)

createOrUpdateUserContent

public void createOrUpdateUserContent(javaposse.jobdsl.dsl.UserContent userContent,
                                      boolean ignoreExisting)

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

queueJob

public void queueJob(java.lang.String path)
              throws javaposse.jobdsl.dsl.NameNotProvidedException

Throws:

javaposse.jobdsl.dsl.NameNotProvidedException

streamFileInWorkspace

public java.io.InputStream streamFileInWorkspace(java.lang.String relLocation)
                                          throws java.io.IOException,
                                                 java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

readFileInWorkspace

public java.lang.String readFileInWorkspace(java.lang.String relLocation)
                                     throws java.io.IOException,
                                            java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

readFileInWorkspace

public java.lang.String readFileInWorkspace(java.lang.String jobName,
                                            java.lang.String relLocation)
                                     throws java.io.IOException,
                                            java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

logPluginDeprecationWarning

public void logPluginDeprecationWarning(java.lang.String pluginShortName,
                                        java.lang.String minimumVersion)

logDeprecationWarning

protected void logDeprecationWarning(java.lang.String subject,
                                     java.lang.String details)

Overrides:

logDeprecationWarning in class javaposse.jobdsl.dsl.AbstractJobManagement

requirePlugin

public void requirePlugin(java.lang.String pluginShortName)

Specified by:

requirePlugin in interface javaposse.jobdsl.dsl.JobManagement

Overrides:

requirePlugin in class javaposse.jobdsl.dsl.AbstractJobManagement

requirePlugin

public void requirePlugin(java.lang.String pluginShortName,
                          boolean failIfMissing)

requireMinimumPluginVersion

public void requireMinimumPluginVersion(java.lang.String pluginShortName,
                                        java.lang.String version)

Specified by:

requireMinimumPluginVersion in interface javaposse.jobdsl.dsl.JobManagement

Overrides:

requireMinimumPluginVersion in class javaposse.jobdsl.dsl.AbstractJobManagement

requireMinimumPluginVersion

public void requireMinimumPluginVersion(java.lang.String pluginShortName,
                                        java.lang.String version,
                                        boolean failIfMissing)

requireMinimumCoreVersion

public void requireMinimumCoreVersion(java.lang.String version)

isMinimumPluginVersionInstalled

public boolean isMinimumPluginVersionInstalled(java.lang.String pluginShortName,
                                               java.lang.String version)

isMinimumCoreVersion

public boolean isMinimumCoreVersion(java.lang.String version)

getVSphereCloudHash

public java.lang.Integer getVSphereCloudHash(java.lang.String name)

renameJobMatching

public void renameJobMatching(java.lang.String previousNames,
                              java.lang.String destination)
                       throws java.io.IOException

Throws:

java.io.IOException

getPermissions

public java.util.Set<java.lang.String> getPermissions(java.lang.String descriptorId)

callExtension

public groovy.util.Node callExtension(java.lang.String name,
                                      javaposse.jobdsl.dsl.Item item,
                                      java.lang.Class<? extends javaposse.jobdsl.dsl.ExtensibleContext> contextType,
                                      java.lang.Object... args)
                               throws java.lang.Throwable

Throws:

java.lang.Throwable