Package jenkins.branch

Class MultiBranchProjectFactory

java.lang.Object

hudson.model.AbstractDescribableImpl<MultiBranchProjectFactory>

jenkins.branch.MultiBranchProjectFactory

All Implemented Interfaces:

ExtensionPoint, Describable<MultiBranchProjectFactory>

Direct Known Subclasses:

MultiBranchProjectFactory.BySCMSourceCriteria

public abstract class MultiBranchProjectFactory
extends AbstractDescribableImpl<MultiBranchProjectFactory>
implements ExtensionPoint

Creates MultiBranchProjects for repositories where recognized. Please define a 'getting-started' view for a subclass, if you would like to provide specific information to the user how to get started using the type of project factory. This view is displayed when there are no subfolders found.

Since:

0.2-beta-5

See Also:

OrganizationFolder.getProjectFactories()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiBranchProjectFactory.BySCMSourceCriteria	Creates a particular kind of multibranch project insofar as at least one SCMHead satisfies a probe.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
MultiBranchProjectFactory()

Method Summary

Modifier and Type	Method	Description
MultiBranchProject<?,?>	createNewProject(ItemGroup<?> parent, String name, List<? extends jenkins.scm.api.SCMSource> scmSources, Map<String,Object> attributes, TaskListener listener)	Creates a new multibranch project which matches recognizes(hudson.model.ItemGroup<?>, java.lang.String, java.util.List<? extends jenkins.scm.api.SCMSource>, java.util.Map<java.lang.String, java.lang.Object>, hudson.model.TaskListener).
MultiBranchProject<?,?>	createProject(ItemGroup<?> parent, String name, List<? extends jenkins.scm.api.SCMSource> scmSources, Map<String,Object> attributes, TaskListener listener)	Deprecated. use createNewProject(ItemGroup, String, List, Map, TaskListener)
MultiBranchProjectFactoryDescriptor	getDescriptor()
boolean	recognizes(ItemGroup<?> parent, String name, List<? extends jenkins.scm.api.SCMSource> scmSources, Map<String,Object> attributes, TaskListener listener)	Determines whether this factory recognizes a given configuration.
boolean	recognizes(ItemGroup<?> parent, String name, List<? extends jenkins.scm.api.SCMSource> scmSources, Map<String,Object> attributes, jenkins.scm.api.SCMHeadEvent<?> event, TaskListener listener)	Determines whether this factory recognizes a given configuration scoped to a specific SCMHeadEvent.
void	updateExistingProject(MultiBranchProject<?,?> project, Map<String,Object> attributes, TaskListener listener)	Updates an existing project which matches recognizes(hudson.model.ItemGroup<?>, java.lang.String, java.util.List<? extends jenkins.scm.api.SCMSource>, java.util.Map<java.lang.String, java.lang.Object>, hudson.model.TaskListener).

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiBranchProjectFactory

public MultiBranchProjectFactory()

Method Detail

recognizes

public boolean recognizes(@NonNull
                          ItemGroup<?> parent,
                          @NonNull
                          String name,
                          @NonNull
                          List<? extends jenkins.scm.api.SCMSource> scmSources,
                          @NonNull
                          Map<String,Object> attributes,
                          @NonNull
                          TaskListener listener)
                   throws IOException,
                          InterruptedException

Determines whether this factory recognizes a given configuration.

Parameters:

parent - a folder

name - a project name

scmSources - a set of SCM sources as added by SCMSourceObserver.ProjectObserver.addSource(jenkins.scm.api.SCMSource)

attributes - a set of metadata attributes as added by SCMSourceObserver.ProjectObserver.addAttribute(java.lang.String, java.lang.Object)

listener - a way of reporting progress

Returns:

true if recognized

Throws:

InterruptedException - if interrupted.

IOException - if there was an IO error.

recognizes

public boolean recognizes(@NonNull
                          ItemGroup<?> parent,
                          @NonNull
                          String name,
                          @NonNull
                          List<? extends jenkins.scm.api.SCMSource> scmSources,
                          @NonNull
                          Map<String,Object> attributes,
                          @CheckForNull
                          jenkins.scm.api.SCMHeadEvent<?> event,
                          @NonNull
                          TaskListener listener)
                   throws IOException,
                          InterruptedException

Determines whether this factory recognizes a given configuration scoped to a specific SCMHeadEvent.

Parameters:

parent - a folder

name - a project name

scmSources - a set of SCM sources as added by SCMSourceObserver.ProjectObserver.addSource(jenkins.scm.api.SCMSource)

attributes - a set of metadata attributes as added by SCMSourceObserver.ProjectObserver.addAttribute(java.lang.String, java.lang.Object)

event - the SCMHeadEvent that the recognition test should be restricted to.

listener - a way of reporting progress

Returns:

true if recognized

Throws:

InterruptedException - if interrupted.

IOException - if there was an IO error.

Since:

2.0

createNewProject

@NonNull
public MultiBranchProject<?,?> createNewProject(@NonNull
                                                      ItemGroup<?> parent,
                                                      @NonNull
                                                      String name,
                                                      @NonNull
                                                      List<? extends jenkins.scm.api.SCMSource> scmSources,
                                                      @NonNull
                                                      Map<String,Object> attributes,
                                                      @NonNull
                                                      TaskListener listener)
                                               throws IOException,
                                                      InterruptedException

Creates a new multibranch project which matches recognizes(hudson.model.ItemGroup<?>, java.lang.String, java.util.List<? extends jenkins.scm.api.SCMSource>, java.util.Map<java.lang.String, java.lang.Object>, hudson.model.TaskListener).

Parameters:

parent - a folder

name - a project name

scmSources - a set of SCM sources as added by SCMSourceObserver.ProjectObserver.addSource(jenkins.scm.api.SCMSource)

attributes - a set of metadata attributes as added by SCMSourceObserver.ProjectObserver.addAttribute(java.lang.String, java.lang.Object)

listener - a way of reporting progress

Returns:

a new uninitialized multibranch project (do not configure its MultiBranchProject.getSourcesList() or call ComputedFolder.onCreatedFromScratch())

Throws:

InterruptedException - if interrupted.

IOException - if there was an IO error.

updateExistingProject

public void updateExistingProject(@NonNull
                                  MultiBranchProject<?,?> project,
                                  @NonNull
                                  Map<String,Object> attributes,
                                  @NonNull
                                  TaskListener listener)
                           throws IOException,
                                  InterruptedException

Updates an existing project which matches recognizes(hudson.model.ItemGroup<?>, java.lang.String, java.util.List<? extends jenkins.scm.api.SCMSource>, java.util.Map<java.lang.String, java.lang.Object>, hudson.model.TaskListener).

Parameters:

project - an existing project, perhaps created by this factory, perhaps not

attributes - a set of metadata attributes as added by SCMSourceObserver.ProjectObserver.addAttribute(java.lang.String, java.lang.Object)

listener - a way of reporting progress

Throws:

InterruptedException - if interrupted.

IOException - if there was an IO error.

createProject

@Deprecated
@CheckForNull
public MultiBranchProject<?,?> createProject(@NonNull
                                                   ItemGroup<?> parent,
                                                   @NonNull
                                                   String name,
                                                   @NonNull
                                                   List<? extends jenkins.scm.api.SCMSource> scmSources,
                                                   @NonNull
                                                   Map<String,Object> attributes,
                                                   @NonNull
                                                   TaskListener listener)
                                            throws IOException,
                                                   InterruptedException

Deprecated.

use createNewProject(ItemGroup, String, List, Map, TaskListener)

Creates a new multibranch project which matches recognizes(hudson.model.ItemGroup<?>, java.lang.String, java.util.List<? extends jenkins.scm.api.SCMSource>, java.util.Map<java.lang.String, java.lang.Object>, hudson.model.TaskListener).

Parameters:

parent - a folder

name - a project name

scmSources - a set of SCM sources as added by SCMSourceObserver.ProjectObserver.addSource(jenkins.scm.api.SCMSource)

attributes - a set of metadata attributes as added by SCMSourceObserver.ProjectObserver.addAttribute(java.lang.String, java.lang.Object)

listener - a way of reporting progress

Returns:

a new uninitialized multibranch project (do not configure its MultiBranchProject.getSourcesList() or call ComputedFolder.onCreatedFromScratch())

Throws:

InterruptedException - if interrupted.

IOException - if there was an IO error.

getDescriptor

public MultiBranchProjectFactoryDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<MultiBranchProjectFactory>

Overrides:

getDescriptor in class AbstractDescribableImpl<MultiBranchProjectFactory>