com.microej.tool.jenkinscli.ant

Class StartJobTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

com.microej.tool.jenkinscli.ant.StartJobTask

All Implemented Interfaces:

Cloneable

public class StartJobTask
extends Task

This class allows to start a job with the Jenkins API from Apache Ant.

Usage :
Include the jar file containing JenkinsAPI and StartJobTask classes in your Ant file :

 <path id="jenkins.cli.path">
        <fileset dir="[jenkins_cli_directory]">
                <include name="jenkins-cli.jar"/>
        </fileset>
 </path>
 

Define a task to start jobs :

 <taskdef name="startjob" classname="com.microej.tool.jenkinscli.ant.StartJobTask" classpathref="jenkins.cli.path"/>
 

Start a job with required properties and parameters :

 <startjob
        userName="[user_name]"
        userToken="[user_token]"
        jenkinsUrl="[jenkins_url]"
        jobName="[jobname]"
 >
        <stringParameter name="[string_param_name]" string="[string]"/>
        <fileParameter name="[file_param_name]" file="[file_location]"/>
 </startjob>
 

Constructor Summary

Constructors

Constructor and Description
StartJobTask()

Method Summary

Modifier and Type	Method and Description
JenkinsAPI.FileParameter	createFileParameter() Allows Ant to create a FileParameter.
JenkinsAPI.StringParameter	createStringParameter() Allows Ant to create a StringParameter.
void	execute() Called by Ant.
void	setJenkinsUrl(String jenkinsUrl) Sets the Jenkins URL.
void	setJobName(String jobName) Sets the job name.
void	setUserName(String userName) Sets the user name.
void	setUserToken(String userToken) Sets the user token.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

StartJobTask

public StartJobTask()

Method Detail

createFileParameter

public JenkinsAPI.FileParameter createFileParameter()

Allows Ant to create a FileParameter.

Returns:

The FileParameter that was created.

createStringParameter

public JenkinsAPI.StringParameter createStringParameter()

Allows Ant to create a StringParameter.

Returns:

The StringParameter that was created.

execute

public void execute()

Called by Ant. Sets user credentials, starts the job with parameters and monitors it.

Overrides:

execute in class Task

setJenkinsUrl

public void setJenkinsUrl(String jenkinsUrl)

Sets the Jenkins URL.

Parameters:

jenkinsUrl - The Jenkins URL.

setJobName

public void setJobName(String jobName)

Sets the job name.

Parameters:

jobName - The job name.

setUserName

public void setUserName(String userName)

Sets the user name.

Parameters:

userName - The user name.

setUserToken

public void setUserToken(String userToken)

Sets the user token.

Parameters:

userToken - The user token.