Package jenkins.scm.impl

Class SingleSCMSource

java.lang.Object

hudson.model.AbstractDescribableImpl<SCMSource>

jenkins.scm.api.SCMSource

jenkins.scm.impl.SingleSCMSource

All Implemented Interfaces:

ExtensionPoint, Describable<SCMSource>

public class SingleSCMSource
extends SCMSource

A single fixed branch using a legacy SCM implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingleSCMSource.DescriptorImpl	Our descriptor.

Nested classes/interfaces inherited from class jenkins.scm.api.SCMSource

SCMSource.SourceByItem

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class jenkins.scm.api.SCMSource

PRONOUN

Constructor Summary

Constructors

Constructor	Description
SingleSCMSource(String name, SCM scm)	Our constructor.
SingleSCMSource(String id, String name, SCM scm)	Deprecated. use SingleSCMSource(String, SCM) and SCMSource.setId(String).

Method Summary

Modifier and Type	Method	Description
SCM	build(SCMHead head, SCMRevision revision)	Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.
String	getName()
SCM	getScm()
protected void	retrieve(SCMSourceCriteria criteria, SCMHeadObserver observer, SCMHeadEvent<?> event, TaskListener listener)	SPI: Fetches the latest heads and corresponding revisions that are originating from the supplied event.
String	toString()

Methods inherited from class jenkins.scm.api.SCMSource

afterSave, build, canProbe, checkInterrupt, createProbe, defaultListener, equals, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetchActions, fetchActions, fetchActions, fetchRevisions, fetchRevisions, fromSCMFileSystem, getCategories, getCriteria, getDescriptor, getId, getOwner, getPronoun, getTraits, getTrustedRevision, hashCode, hasId, isCategoryEnabled, newProbe, parentHeads, parentRevisions, retrieve, retrieve, retrieve, retrieve, retrieve, retrieve, retrieve, retrieveActions, retrieveActions, retrieveActions, retrieveRevisions, retrieveRevisions, setId, setOwner, setTraits, withId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SingleSCMSource

@DataBoundConstructor
public SingleSCMSource(String name,
                       SCM scm)

Our constructor.

Parameters:

name - the name of the branch.

scm - the configuration.

Since:

2.2.0

SingleSCMSource

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince("2.2.0")
@Deprecated
public SingleSCMSource(String id,
                       String name,
                       SCM scm)

Deprecated.

use SingleSCMSource(String, SCM) and SCMSource.setId(String).

Legacy constructor.

Parameters:

id - source id.

name - the name of the branch.

scm - the configuration.

Method Detail

getName

public String getName()

getScm

public SCM getScm()

retrieve

protected void retrieve(@CheckForNull
                        SCMSourceCriteria criteria,
                        @NonNull
                        SCMHeadObserver observer,
                        @CheckForNull
                        SCMHeadEvent<?> event,
                        @NonNull
                        TaskListener listener)
                 throws IOException,
                        InterruptedException

Description copied from class: SCMSource

SPI: Fetches the latest heads and corresponding revisions that are originating from the supplied event. If the supplied event is one that the implementer trusts, then the implementer may be able to optimize retrieval to minimize round trips. Implementers are free to cache intermediary results but the call must always check the validity of any intermediary caches.

It is vitally important that implementations must periodically call SCMSource.checkInterrupt() otherwise it will be impossible for users to interrupt the operation.

The default implementation wraps the SCMHeadObserver using SCMHeadEvent.filter(SCMSource, SCMHeadObserver) and delegates to SCMSource.retrieve(SCMSourceCriteria, SCMHeadObserver, TaskListener)

Specified by:

retrieve in class SCMSource

Parameters:

criteria - the criteria to use, if non-null them implementations mustfilter all SCMHead instances against the SCMSourceCriteria.isHead(SCMSourceCriteria.Probe, TaskListener) before passing through to the SCMHeadObserver.

observer - an observer of interim results, if the event is non-null then the observer will already have been filtered with SCMHeadEvent.filter(SCMSource, SCMHeadObserver).

event - the (optional) event from which the operation should be scoped.

listener - the task listener.

Throws:

IOException - if an error occurs while performing the operation.

InterruptedException - if any thread has interrupted the current thread.

build

@NonNull
public SCM build(@NonNull
                 SCMHead head,
                 @CheckForNull
                 SCMRevision revision)

Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.

Specified by:

build in class SCMSource

Parameters:

head - the head.

revision - the revision or null.

Returns:

the SCM instance.

toString

public String toString()

Overrides:

toString in class SCMSource