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 final class JenkinsJobManagement
extends javaposse.jobdsl.dsl.AbstractJobManagement

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JenkinsJobManagement.ExtractTemplate

Field Summary

Fields inherited from class javaposse.jobdsl.dsl.AbstractJobManagement

out

Constructor Summary

Constructors

Constructor and Description
JenkinsJobManagement(java.io.PrintStream outputLogger, hudson.EnvVars envVars, hudson.model.AbstractBuild<?,?> build)
JenkinsJobManagement(java.io.PrintStream outputLogger, hudson.EnvVars envVars, hudson.model.AbstractBuild<?,?> build, LookupStrategy lookupStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createOrUpdateConfig(java.lang.String path, java.lang.String config, boolean ignoreExisting)
java.lang.String	createOrUpdateConfigFile(javaposse.jobdsl.dsl.ConfigFile configFile, boolean ignoreExisting)
void	createOrUpdateView(java.lang.String path, java.lang.String config, boolean ignoreExisting)
java.lang.String	getConfig(java.lang.String path)
java.lang.String	getConfigFileId(javaposse.jobdsl.dsl.ConfigFileType type, java.lang.String name)
java.lang.String	getCredentialsId(java.lang.String credentialsDescription)
java.util.Map<java.lang.String,java.lang.String>	getParameters()
hudson.util.VersionNumber	getPluginVersion(java.lang.String pluginShortName)
static java.util.Set<java.lang.String>	getTemplates(java.util.Collection<javaposse.jobdsl.dsl.GeneratedJob> jobs)
java.lang.Integer	getVSphereCloudHash(java.lang.String name)
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	requireMinimumPluginVersion(java.lang.String pluginShortName, java.lang.String version)
java.io.InputStream	streamFileInWorkspace(java.lang.String relLocation)

Methods inherited from class javaposse.jobdsl.dsl.AbstractJobManagement

getMetaClass, getOutputStream, getProperty, getSourceDetails, getStackTrace, invokeMethod, logDeprecationWarning, 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,
                    hudson.EnvVars envVars,
                    hudson.model.AbstractBuild<?,?> build,
                    LookupStrategy lookupStrategy)

JenkinsJobManagement

public JenkinsJobManagement(java.io.PrintStream outputLogger,
                    hudson.EnvVars envVars,
                    hudson.model.AbstractBuild<?,?> build)

Method Detail

getConfig

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

Throws:

javaposse.jobdsl.dsl.JobConfigurationNotFoundException

createOrUpdateConfig

public boolean createOrUpdateConfig(java.lang.String path,
                           java.lang.String config,
                           boolean ignoreExisting)
                             throws javaposse.jobdsl.dsl.NameNotProvidedException,
                                    javaposse.jobdsl.dsl.ConfigurationMissingException

Throws:

javaposse.jobdsl.dsl.NameNotProvidedException

javaposse.jobdsl.dsl.ConfigurationMissingException

createOrUpdateView

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

createOrUpdateConfigFile

public java.lang.String createOrUpdateConfigFile(javaposse.jobdsl.dsl.ConfigFile configFile,
                                        boolean ignoreExisting)

getParameters

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

Specified by:

getParameters in interface javaposse.jobdsl.dsl.JobManagement

Overrides:

getParameters in class javaposse.jobdsl.dsl.AbstractJobManagement

getCredentialsId

public java.lang.String getCredentialsId(java.lang.String credentialsDescription)

queueJob

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

Specified by:

queueJob in interface javaposse.jobdsl.dsl.JobManagement

Overrides:

queueJob in class javaposse.jobdsl.dsl.AbstractJobManagement

Throws:

javaposse.jobdsl.dsl.NameNotProvidedException

streamFileInWorkspace

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

Specified by:

streamFileInWorkspace in interface javaposse.jobdsl.dsl.JobManagement

Overrides:

streamFileInWorkspace in class javaposse.jobdsl.dsl.AbstractJobManagement

Throws:

java.io.IOException

readFileInWorkspace

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

Specified by:

readFileInWorkspace in interface javaposse.jobdsl.dsl.JobManagement

Overrides:

readFileInWorkspace in class javaposse.jobdsl.dsl.AbstractJobManagement

Throws:

java.io.IOException

readFileInWorkspace

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

Specified by:

readFileInWorkspace in interface javaposse.jobdsl.dsl.JobManagement

Overrides:

readFileInWorkspace in class javaposse.jobdsl.dsl.AbstractJobManagement

Throws:

java.io.IOException

requireMinimumPluginVersion

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

getPluginVersion

public hudson.util.VersionNumber getPluginVersion(java.lang.String pluginShortName)

getVSphereCloudHash

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

getConfigFileId

public java.lang.String getConfigFileId(javaposse.jobdsl.dsl.ConfigFileType type,
                               java.lang.String name)

getTemplates

public static java.util.Set<java.lang.String> getTemplates(java.util.Collection<javaposse.jobdsl.dsl.GeneratedJob> jobs)