org.aerogear.digger.client.services

Class JobService

java.lang.Object

org.aerogear.digger.client.services.JobService

public class JobService
extends Object

Create digger job on jenkins platform

Constructor Summary

Constructors

Constructor and Description
JobService(boolean crumbFlag) Constructor.

Method Summary

Modifier and Type	Method and Description
void	create(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name, String gitRepo, String gitBranch) Create new digger job on jenkins platform with no parameters.
void	create(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name, String gitRepo, String gitBranch, BuildDiscarder buildDiscarder) Create new digger job on jenkins platform with no parameters.
void	create(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name, String gitRepo, String gitBranch, BuildDiscarder buildDiscarder, com.offbytwo.jenkins.model.credentials.Credential gitRepoCredential, List<BuildParameter> buildParameters) Create new digger job on jenkins platform
void	create(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name, String gitRepo, String gitBranch, com.offbytwo.jenkins.model.credentials.Credential gitRepoCredential, List<BuildParameter> buildParameters) Create new digger job on jenkins platform
void	delete(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name, String givenCredentialId) Delete the job and associated credential.
com.offbytwo.jenkins.model.JobWithDetails	get(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name) Get a digger job on jenkins platform.
void	update(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name, String gitRepo, String gitBranch, BuildDiscarder buildDiscarder) Update digger job on jenkins platform with no parameters.
void	update(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String name, String gitRepo, String gitBranch, BuildDiscarder buildDiscarder, com.offbytwo.jenkins.model.credentials.Credential gitRepoCredential, List<BuildParameter> buildParameters) Update digger job on jenkins platform.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobService

public JobService(boolean crumbFlag)

Constructor.

Parameters:

crumbFlag - Specify if CSRF Protection is enabled on the Jenkins server.

Method Detail

get

public com.offbytwo.jenkins.model.JobWithDetails get(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                                                     String name)
                                              throws IOException

Get a digger job on jenkins platform.

Parameters:

jenkinsServer - Jenkins server client

name - name of the job to retrieve

Returns:

job from Jenkins platform or null if not found

Throws:

IOException

create

public void create(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                   String name,
                   String gitRepo,
                   String gitBranch,
                   BuildDiscarder buildDiscarder,
                   com.offbytwo.jenkins.model.credentials.Credential gitRepoCredential,
                   List<BuildParameter> buildParameters)
            throws IOException,
                   DiggerClientException

Create new digger job on jenkins platform

Parameters:

jenkinsServer - Jenkins server client

name - job name that can be used later to reference job

gitRepo - git repository url (full git repository url. e.g git@github.com:digger/helloworld.git

gitBranch - git repository branch (default branch used to checkout source code)

buildDiscarder - BuildDiscarder instance. See BuildDiscarder

gitRepoCredential - credential instance. See Credential.

buildParameters - list of build parameters for the a parameterized job.

Throws:

IOException

DiggerClientException

create

public void create(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                   String name,
                   String gitRepo,
                   String gitBranch,
                   com.offbytwo.jenkins.model.credentials.Credential gitRepoCredential,
                   List<BuildParameter> buildParameters)
            throws IOException,
                   DiggerClientException

Create new digger job on jenkins platform

Parameters:

jenkinsServer - Jenkins server client

name - job name that can be used later to reference job

gitRepo - git repository url (full git repository url. e.g git@github.com:digger/helloworld.git

gitBranch - git repository branch (default branch used to checkout source code)

gitRepoCredential - credential instance. See Credential.

buildParameters - list of build parameters for the a parameterized job.

Throws:

IOException

DiggerClientException

create

public void create(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                   String name,
                   String gitRepo,
                   String gitBranch,
                   BuildDiscarder buildDiscarder)
            throws IOException,
                   DiggerClientException

Create new digger job on jenkins platform with no parameters.

Parameters:

jenkinsServer - Jenkins server client

name - job name that can be used later to reference job

gitRepo - git repository url (full git repository url. e.g git@github.com:digger/helloworld.git

gitBranch - git repository branch (default branch used to checkout source code) * @param storeBuildsDays the number of days a build should be persisted for before cleanup

buildDiscarder - BuildDiscarder instance. See BuildDiscarder

Throws:

IOException

DiggerClientException

See Also:

create(JenkinsServer, String, String, String, BuildDiscarder, Credential, List)

create

public void create(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                   String name,
                   String gitRepo,
                   String gitBranch)
            throws IOException,
                   DiggerClientException

Create new digger job on jenkins platform with no parameters.

Parameters:

jenkinsServer - Jenkins server client

name - job name that can be used later to reference job

gitRepo - git repository url (full git repository url. e.g git@github.com:digger/helloworld.git

gitBranch - git repository branch (default branch used to checkout source code) * @param storeBuildsDays the number of days a build should be persisted for before cleanup

Throws:

IOException

DiggerClientException

See Also:

create(JenkinsServer, String, String, String, BuildDiscarder, Credential, List)

update

public void update(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                   String name,
                   String gitRepo,
                   String gitBranch,
                   BuildDiscarder buildDiscarder,
                   com.offbytwo.jenkins.model.credentials.Credential gitRepoCredential,
                   List<BuildParameter> buildParameters)
            throws DiggerClientException,
                   IOException

Update digger job on jenkins platform. NOTE: If gitRepoCredential is set in #create(JenkinsServer, String, String, String, List, Credential), it needs to be set in here as well. Otherwise it will be removed.

Parameters:

jenkinsServer - Jenkins server client

name - job name that can be used later to reference job

gitRepo - git repository url (full git repository url. e.g git@github.com:digger/helloworld.git

gitBranch - git repository branch (default branch used to checkout source code)

buildDiscarder - BuildDiscarder instance. See BuildDiscarder

gitRepoCredential - credential instance. See Credential.

buildParameters - list of build parameters for the a parameterized job.

Throws:

DiggerClientException

IOException

update

public void update(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                   String name,
                   String gitRepo,
                   String gitBranch,
                   BuildDiscarder buildDiscarder)
            throws IOException,
                   DiggerClientException

Update digger job on jenkins platform with no parameters.

Parameters:

jenkinsServer - Jenkins server client

name - job name that can be used later to reference job

gitRepo - git repository url (full git repository url. e.g git@github.com:digger/helloworld.git

gitBranch - git repository branch (default branch used to checkout source code)

buildDiscarder - BuildDiscarder instance. See BuildDiscarder

Throws:

IOException

DiggerClientException

See Also:

update(JenkinsServer, String, String, String, BuildDiscarder, Credential, List)

delete

public void delete(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                   String name,
                   String givenCredentialId)
            throws IOException

Delete the job and associated credential.

Parameters:

jenkinsServer - the Jenkins server

name - the name of the Jenkins job

givenCredentialId - the id of the credential. It should be the same id value if gitRepoCredential is provided in #create(JenkinsServer, String, String, String, Credential, List) and it has an id value. Otherwise pass null.

Throws:

IOException