io.jenkins.blueocean.scm.api

Class AbstractMultiBranchCreateRequest

java.lang.Object

io.jenkins.blueocean.rest.model.BluePipelineCreateRequest

io.jenkins.blueocean.scm.api.AbstractPipelineCreateRequest

io.jenkins.blueocean.scm.api.AbstractMultiBranchCreateRequest

public abstract class AbstractMultiBranchCreateRequest
extends AbstractPipelineCreateRequest

Creates MultiBranchProjects with a single SCMSource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMultiBranchCreateRequest.JenkinsfileCriteria

Field Summary

Fields inherited from class io.jenkins.blueocean.scm.api.AbstractPipelineCreateRequest

scmConfig

Constructor Summary

Constructors

Constructor and Description
AbstractMultiBranchCreateRequest(String name, io.jenkins.blueocean.rest.model.BlueScmConfig scmConfig)

Method Summary

Modifier and Type	Method and Description
io.jenkins.blueocean.rest.model.BluePipeline	create(io.jenkins.blueocean.rest.model.BlueOrganization organization, io.jenkins.blueocean.rest.Reachable parent)
protected abstract jenkins.scm.api.SCMSource	createSource(jenkins.branch.MultiBranchProject project, io.jenkins.blueocean.rest.model.BlueScmConfig scmConfig) Create the source for the MultiBranchProject created with this request
protected AbstractScmSourceEvent	getScmSourceEvent(jenkins.branch.MultiBranchProject project, jenkins.scm.api.SCMSource source)
protected boolean	repoHasJenkinsFile(jenkins.scm.api.SCMSource scmSource) Certain SCMSource can tell whether it can detect presence of Jenkinsfile across all branches
protected abstract List<io.jenkins.blueocean.commons.ErrorMessage.Error>	validate(String name, io.jenkins.blueocean.rest.model.BlueScmConfig scmConfig) Validate the provided SCMConfig and test that a connection can be made to the SCM server

Methods inherited from class io.jenkins.blueocean.scm.api.AbstractPipelineCreateRequest

checkUserIsAuthenticatedAndHasItemCreatePermission, computeCredentialId, createProject, getParent

Methods inherited from class io.jenkins.blueocean.rest.model.BluePipelineCreateRequest

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMultiBranchCreateRequest

public AbstractMultiBranchCreateRequest(String name,
                                        io.jenkins.blueocean.rest.model.BlueScmConfig scmConfig)

Method Detail

create

public io.jenkins.blueocean.rest.model.BluePipeline create(@Nonnull
                                                           io.jenkins.blueocean.rest.model.BlueOrganization organization,
                                                           @Nonnull
                                                           io.jenkins.blueocean.rest.Reachable parent)
                                                    throws IOException

Specified by:

create in class io.jenkins.blueocean.rest.model.BluePipelineCreateRequest

Throws:

IOException

getScmSourceEvent

@Nullable
protected AbstractScmSourceEvent getScmSourceEvent(@Nonnull
                                                             jenkins.branch.MultiBranchProject project,
                                                             @Nonnull
                                                             jenkins.scm.api.SCMSource source)

Returns:

Get SCMSourceEvent

createSource

protected abstract jenkins.scm.api.SCMSource createSource(@Nonnull
                                                          jenkins.branch.MultiBranchProject project,
                                                          @Nonnull
                                                          io.jenkins.blueocean.rest.model.BlueScmConfig scmConfig)

Create the source for the MultiBranchProject created with this request

Parameters:

project - that was created

scmConfig - config

Returns:

valid SCMSource

validate

protected abstract List<io.jenkins.blueocean.commons.ErrorMessage.Error> validate(String name,
                                                                                  io.jenkins.blueocean.rest.model.BlueScmConfig scmConfig)

Validate the provided SCMConfig and test that a connection can be made to the SCM server

Parameters:

name - of pipeline being created

scmConfig - to validate

Returns:

errors occurring during validation

repoHasJenkinsFile

protected boolean repoHasJenkinsFile(@Nonnull
                                     jenkins.scm.api.SCMSource scmSource)

Certain SCMSource can tell whether it can detect presence of Jenkinsfile across all branches

Parameters:

scmSource - scm source

Returns:

true as default. false if it can determine there is no Jenkinsfile in all branches