com.microej.tool.jenkinscli

Class JenkinsAPI

java.lang.Object

com.microej.tool.jenkinscli.JenkinsAPI

public class JenkinsAPI
extends Object

API for manipulating Jenkins Jobs.

Usage:
Set the following system properties :

• user.name
• user.token
• jenkins.url

Pass them to the JVM :

 -Duser.name=[user_name]
 

or set them in your Java code :

 System.setProperty("user.name", "[user_name]");
 

Instantiate API and use its methods :

 JenkinsAPI api = new JenkinsAPI();
 api.enableJob("myjob");
 ...
 

Start a job and monitor it :

 String location = api.startJob("myjob");
 int buildNumber = api.getBuildNumber(location);
 api.monitorJob("myjob", buildNumber);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JenkinsAPI.FileParameter Represents a file parameter.
class	JenkinsAPI.LogThread Logs a message at a given time interval.
static class	JenkinsAPI.Parameter Represents a parameter of the Jenkins job.
static class	JenkinsAPI.StringParameter Represents a string parameter.

Constructor Summary

Constructors

Constructor and Description
JenkinsAPI() Constructor of the class.
JenkinsAPI(CloseableHttpClient client) Constructor of the class.

Method Summary

Modifier and Type	Method and Description
void	deleteJob(String jobName) Deletes a job.
void	disableJob(String jobName) Disables a job.
void	enableJob(String jobName) Enables a job.
String[]	getAllJobs(String text) Get all jobs which name contains the given text.
int	getBuildNumber(String location) Returns the number of the build of the given queued item location.
byte[]	getJobConfigXML(String jobName) Gets the config.xml of a job.
List<Integer>	getRunningBuildNumbers(String jobName) Returns a list of the running build numbers.
protected org.w3c.dom.Document	getXmlDocument(InputStream is)
boolean	jobExists(String jobName) Tells whether a job exist or not.
void	monitorJob(String jobName, int buildNumber) Monitors the build of the given job that has the given build number.
protected HttpURLConnection	newHttpURLConnection(String path, String action)
void	newJob(String jobName, byte[] configXML) Creates a new job with the given config.xml.
void	renameJob(String jobName, String jobNewName) Renames a job
String	startJob(String jobName, List<JenkinsAPI.Parameter> parameters) Starts the job that has the given name with the given files and parameters.
void	stopRunningBuild(String jobName) Stops all the running builds for the given job.
void	storeJobConfigXML(String jobName, byte[] configXML) Stores the config.xml of a job.

Methods inherited from class java.lang.Object

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

Constructor Detail

JenkinsAPI

public JenkinsAPI()

Constructor of the class. Initializes URL and credentials. Connects to the Jenkins URL.

JenkinsAPI

public JenkinsAPI(CloseableHttpClient client)

Constructor of the class. Initializes URL and credentials. Connects to the Jenkins URL.

Parameters:

client - The CloseableHttpClient used to communicate with the Jenkins server.

Method Detail

deleteJob

public void deleteJob(String jobName)

Deletes a job.

Parameters:

jobName - the job to delete.

disableJob

public void disableJob(String jobName)

Disables a job.

Parameters:

jobName - the job to disable

enableJob

public void enableJob(String jobName)

Enables a job.

Parameters:

jobName - the job to enable

getAllJobs

public String[] getAllJobs(String text)

Get all jobs which name contains the given text.

Parameters:

text - must not contains white spaces

Returns:

the list of job names matching the given text

getBuildNumber

public int getBuildNumber(String location)

Returns the number of the build of the given queued item location.

Parameters:

location - The location of the queued item.

Returns:

The build number.

getJobConfigXML

public byte[] getJobConfigXML(String jobName)

Gets the config.xml of a job.

Parameters:

jobName - the job to get the configuration

Returns:

config.xml content (UTF-8 encoded)

getRunningBuildNumbers

public List<Integer> getRunningBuildNumbers(String jobName)

Returns a list of the running build numbers.

Parameters:

jobName - The job name.

Returns:

The running build numbers.

getXmlDocument

protected org.w3c.dom.Document getXmlDocument(InputStream is)

jobExists

public boolean jobExists(String jobName)

Tells whether a job exist or not.

Parameters:

jobName - the job to test

Returns:

true if the job exists, false otherwise

monitorJob

public void monitorJob(String jobName,
                       int buildNumber)

Monitors the build of the given job that has the given build number. Prints the console output of the build.

Parameters:

jobName - The name of the job.

buildNumber - The number of the build.

newHttpURLConnection

protected HttpURLConnection newHttpURLConnection(String path,
                                                 String action)
                                          throws IOException

Throws:

IOException

newJob

public void newJob(String jobName,
                   byte[] configXML)

Creates a new job with the given config.xml.

Parameters:

jobName - the job to create

configXML - UTF-8 encoded

renameJob

public void renameJob(String jobName,
                      String jobNewName)

Renames a job

Parameters:

jobName - the job to rename

jobNewName - the new job name

startJob

public String startJob(String jobName,
                       List<JenkinsAPI.Parameter> parameters)

Starts the job that has the given name with the given files and parameters.

Parameters:

jobName - The name of the job.

parameters - The parameters for the job.

Returns:

The location of the job that was started, is null if the job was not started properly.

stopRunningBuild

public void stopRunningBuild(String jobName)

Stops all the running builds for the given job.

Parameters:

jobName - the job.

storeJobConfigXML

public void storeJobConfigXML(String jobName,
                              byte[] configXML)

Stores the config.xml of a job.

Parameters:

jobName - the job to store the configuration

configXML - UTF-8 encoded