jenkins.branch

Class MultiBranchProjectFactory

java.lang.Object

hudson.model.AbstractDescribableImpl<MultiBranchProjectFactory>

jenkins.branch.MultiBranchProjectFactory

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<MultiBranchProjectFactory>

Direct Known Subclasses:

MultiBranchProjectFactory.BySCMSourceCriteria

public abstract class MultiBranchProjectFactory
extends hudson.model.AbstractDescribableImpl<MultiBranchProjectFactory>
implements hudson.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 and 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

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MultiBranchProjectFactory()

Method Summary

Modifier and Type	Method and Description
MultiBranchProject<?,?>	createNewProject(hudson.model.ItemGroup<?> parent, String name, List<? extends jenkins.scm.api.SCMSource> scmSources, Map<String,Object> attributes, hudson.model.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(hudson.model.ItemGroup<?> parent, String name, List<? extends jenkins.scm.api.SCMSource> scmSources, Map<String,Object> attributes, hudson.model.TaskListener listener) Deprecated.
MultiBranchProjectFactoryDescriptor	getDescriptor()
boolean	recognizes(hudson.model.ItemGroup<?> parent, String name, List<? extends jenkins.scm.api.SCMSource> scmSources, Map<String,Object> attributes, hudson.model.TaskListener listener) Determines whether this factory recognizes a given configuration.
void	updateExistingProject(MultiBranchProject<?,?> project, Map<String,Object> attributes, hudson.model.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
                          hudson.model.ItemGroup<?> parent,
                          @Nonnull
                          String name,
                          @Nonnull
                          List<? extends jenkins.scm.api.SCMSource> scmSources,
                          @Nonnull
                          Map<String,Object> attributes,
                          @Nonnull
                          hudson.model.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:

IOException

InterruptedException

createNewProject

@Nonnull
public MultiBranchProject<?,?> createNewProject(@Nonnull
                                                         hudson.model.ItemGroup<?> parent,
                                                         @Nonnull
                                                         String name,
                                                         @Nonnull
                                                         List<? extends jenkins.scm.api.SCMSource> scmSources,
                                                         @Nonnull
                                                         Map<String,Object> attributes,
                                                         @Nonnull
                                                         hudson.model.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 AbstractItem.onCreatedFromScratch())

Throws:

IOException

InterruptedException

updateExistingProject

public void updateExistingProject(MultiBranchProject<?,?> project,
                                  @Nonnull
                                  Map<String,Object> attributes,
                                  @Nonnull
                                  hudson.model.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:

IOException

InterruptedException

createProject

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

Deprecated.

Throws:

IOException

InterruptedException

getDescriptor

public MultiBranchProjectFactoryDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<MultiBranchProjectFactory>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<MultiBranchProjectFactory>