org.azyva.dragom.jenkins

Interface JenkinsClient

All Known Implementing Classes:

DefaultJenkinsClientImpl

public interface JenkinsClient

Jenkins client interface which represents interactions with Jenkins through its REST API.

This interface defines the calls that are useful for Dragom. It is not meant to be a full-featured implementation of the Jenkins API.

Implementations of this interface are intended to be obtained using ServiceLocator so they can easily be doubled for testing purposes. The main implementation is DefaultJenkinsClientImpl which therefore has a no-argument constructor. This is why setup methods such as setBaseUrl(java.lang.String) are part of this interface.

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JenkinsClient.Build Represents a build.
static class	JenkinsClient.BuildState Build states.
static class	JenkinsClient.HttpStatusException Exception that wraps an HTTP status code.
static class	JenkinsClient.ItemType Types of items.

Method Summary

Modifier and Type	Method and Description
JenkinsClient.Build	build(String job, Map<String,String> mapBuildParam) Triggers a build for a job.
void	createJob(String job, Reader readerConfig) Creates a regular non-templatized job.
boolean	createSimpleFolder(String folder) Creates a simple folder.
void	createUpdateJob(String job, Reader readerConfig) Creates or updates a regular non-templatized job.
void	createUpdateJobFromTemplate(String template, String job, Map<String,String> mapTemplateParam) Created a job from a template.
boolean	deleteItem(String item) Deletes an item.
JenkinsClient.ItemType	getItemType(String item) Returns the JenkinsClient.ItemType.
boolean	isFolderEmpty(String folder)
void	setBaseUrl(String baseUrl) Sets the Jenkins base URL.
void	setPassword(String password) Sets the password to access Jenkins.
void	setUser(String user) Sets the user to access Jenkins.
void	updateJob(String job, Reader readerConfig) Updates a regular non-templatized job.
boolean	validateCredentials()

Method Detail

setBaseUrl

void setBaseUrl(String baseUrl)

Sets the Jenkins base URL.

Parameters:

baseUrl - See description.

setUser

void setUser(String user)

Sets the user to access Jenkins. If null (or not set) Jenkins is accessed anonymously.

Parameters:

user - See description.

setPassword

void setPassword(String password)

Sets the password to access Jenkins. null if user (see setUser(java.lang.String)) is null.

Parameters:

password - See description.

validateCredentials

boolean validateCredentials()

Returns:

Indicates if the credentials provided are valid.

getItemType

JenkinsClient.ItemType getItemType(String item)

Returns the JenkinsClient.ItemType.

Returns null if the item does not exist.

Parameters:

item - Item (full name).

Returns:

See description.

deleteItem

boolean deleteItem(String item)

Deletes an item.

Parameters:

item - Item (full name).

Returns:

Indicates if the item existed and was deleted.

createUpdateJobFromTemplate

void createUpdateJobFromTemplate(String template,
                                 String job,
                                 Map<String,String> mapTemplateParam)

Created a job from a template.

Parameters:

template - Template (full name).

job - New job (full name).

mapTemplateParam - Template parameters.

createJob

void createJob(String job,
               Reader readerConfig)

Creates a regular non-templatized job.

Parameters:

job - New job (full name).

readerConfig - Reader providing the configuration of the job.

updateJob

void updateJob(String job,
               Reader readerConfig)

Updates a regular non-templatized job.

Parameters:

job - Job (full name).

readerConfig - Reader providing the configuration of the job.

createUpdateJob

void createUpdateJob(String job,
                     Reader readerConfig)

Creates or updates a regular non-templatized job.

Parameters:

job - Job (full name).

readerConfig - Reader providing the configuration of the job.

build

JenkinsClient.Build build(String job,
                          Map<String,String> mapBuildParam)

Triggers a build for a job.

Parameters:

job - Job (full name).

mapBuildParam - Build parameters. Can be null.

Returns:

Build.

isFolderEmpty

boolean isFolderEmpty(String folder)

createSimpleFolder

boolean createSimpleFolder(String folder)

Creates a simple folder.

Parameters:

folder - Folder (full name).

Returns:

Indicates if the folder was created. false is returned if it already exited.