org.azyva.dragom.jenkins.impl

Class DefaultJenkinsClientImpl

java.lang.Object

org.azyva.dragom.jenkins.impl.DefaultJenkinsClientImpl

All Implemented Interfaces:

JenkinsClient

public class DefaultJenkinsClientImpl
extends Object
implements JenkinsClient

Main implementation of JenkinsClient.

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultJenkinsClientImpl.DefaultBuildImpl Main implementation of JenkinsClient.Build.

Nested classes/interfaces inherited from interface org.azyva.dragom.jenkins.JenkinsClient

JenkinsClient.Build, JenkinsClient.BuildState, JenkinsClient.HttpStatusException, JenkinsClient.ItemType

Constructor Summary

Constructors

Constructor and Description
DefaultJenkinsClientImpl() Default constructor.

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)
static void	main(String[] args)
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJenkinsClientImpl

public DefaultJenkinsClientImpl()

Default constructor.

Method Detail

setBaseUrl

public void setBaseUrl(String baseUrl)

Description copied from interface: JenkinsClient

Sets the Jenkins base URL.

Specified by:

setBaseUrl in interface JenkinsClient

Parameters:

baseUrl - See description.

setUser

public void setUser(String user)

Description copied from interface: JenkinsClient

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

Specified by:

setUser in interface JenkinsClient

Parameters:

user - See description.

setPassword

public void setPassword(String password)

Description copied from interface: JenkinsClient

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

Specified by:

setPassword in interface JenkinsClient

Parameters:

password - See description.

validateCredentials

public boolean validateCredentials()

Specified by:

validateCredentials in interface JenkinsClient

Returns:

Indicates if the credentials provided are valid.

getItemType

public JenkinsClient.ItemType getItemType(String item)

Description copied from interface: JenkinsClient

Returns the JenkinsClient.ItemType.

Returns null if the item does not exist.

Specified by:

getItemType in interface JenkinsClient

Parameters:

item - Item (full name).

Returns:

See description.

deleteItem

public boolean deleteItem(String item)

Description copied from interface: JenkinsClient

Deletes an item.

Specified by:

deleteItem in interface JenkinsClient

Parameters:

item - Item (full name).

Returns:

Indicates if the item existed and was deleted.

createUpdateJobFromTemplate

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

Description copied from interface: JenkinsClient

Created a job from a template.

Specified by:

createUpdateJobFromTemplate in interface JenkinsClient

Parameters:

template - Template (full name).

job - New job (full name).

mapTemplateParam - Template parameters.

createJob

public void createJob(String job,
                      Reader readerConfig)

Description copied from interface: JenkinsClient

Creates a regular non-templatized job.

Specified by:

createJob in interface JenkinsClient

Parameters:

job - New job (full name).

readerConfig - Reader providing the configuration of the job.

updateJob

public void updateJob(String job,
                      Reader readerConfig)

Description copied from interface: JenkinsClient

Updates a regular non-templatized job.

Specified by:

updateJob in interface JenkinsClient

Parameters:

job - Job (full name).

readerConfig - Reader providing the configuration of the job.

createUpdateJob

public void createUpdateJob(String job,
                            Reader readerConfig)

Description copied from interface: JenkinsClient

Creates or updates a regular non-templatized job.

Specified by:

createUpdateJob in interface JenkinsClient

Parameters:

job - Job (full name).

readerConfig - Reader providing the configuration of the job.

build

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

Description copied from interface: JenkinsClient

Triggers a build for a job.

Specified by:

build in interface JenkinsClient

Parameters:

job - Job (full name).

mapBuildParam - Build parameters. Can be null.

Returns:

Build.

isFolderEmpty

public boolean isFolderEmpty(String folder)

Specified by:

isFolderEmpty in interface JenkinsClient

createSimpleFolder

public boolean createSimpleFolder(String folder)

Description copied from interface: JenkinsClient

Creates a simple folder.

Specified by:

createSimpleFolder in interface JenkinsClient

Parameters:

folder - Folder (full name).

Returns:

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

main

public static void main(String[] args)