jenkins.plugins.git

Class AbstractGitSCMSource

java.lang.Object

hudson.model.AbstractDescribableImpl<jenkins.scm.api.SCMSource>

jenkins.scm.api.SCMSource

jenkins.plugins.git.AbstractGitSCMSource

All Implemented Interfaces:

ExtensionPoint, Describable<jenkins.scm.api.SCMSource>

Direct Known Subclasses:

GitSCMSource

public abstract class AbstractGitSCMSource
extends jenkins.scm.api.SCMSource

Base class for SCMSource implementations that produce GitSCM implementations.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractGitSCMSource.SCMRevisionImpl Our implementation.
static class	AbstractGitSCMSource.SpecificRevisionBuildChooser

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

jenkins.scm.api.SCMSource.SourceByItem

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REMOTE_NAME The default remote name to use when configuring the ref specs to use with fetch operations.
static String	REF_SPEC_DEFAULT The default ref spec template.
static String	REF_SPEC_REMOTE_NAME_PLACEHOLDER The regex for REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR.
static String	REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR The placeholder to use in ref spec templates in order to correctly ensure that the ref spec remote name matches the remote name.

Fields inherited from class jenkins.scm.api.SCMSource

PRONOUN

Constructor Summary

Constructors

Constructor and Description
AbstractGitSCMSource()
AbstractGitSCMSource(String id) Deprecated.

Method Summary

Modifier and Type	Method and Description
SCM	build(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMRevision revision)
protected void	decorate(GitSCMBuilder<?> builder) Performs final decoration of the GitSCMBuilder.
GitRepositoryBrowser	getBrowser() Deprecated. use GitBrowserSCMSourceTrait
protected static File	getCacheDir(String cacheEntry)
protected static File	getCacheDir(String cacheEntry, boolean createDirectory)
protected String	getCacheEntry()
protected static Lock	getCacheLock(String cacheEntry)
protected com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	getCredentials()
abstract String	getCredentialsId()
String	getExcludes() Deprecated. use WildcardSCMSourceFilterTrait
List<GitSCMExtension>	getExtensions() Deprecated. use corresponding GitSCMExtensionTrait (and if there isn't one then likely the GitSCMExtension is not appropriate to use in the context of a SCMSource)
String	getGitTool() Deprecated. use GitToolSCMSourceTrait
String	getIncludes() Deprecated. use WildcardSCMSourceFilterTrait
protected List<org.eclipse.jgit.transport.RefSpec>	getRefSpecs() Deprecated. use RefSpecsSCMSourceTrait
abstract String	getRemote()
protected List<UserRemoteConfig>	getRemoteConfigs() Deprecated. use GitSCMBuilder.asRemoteConfigs()
String	getRemoteName() Deprecated. use RemoteNameSCMSourceTrait
List<jenkins.scm.api.trait.SCMSourceTrait>	getTraits() Returns the SCMSourceTrait instances for this AbstractGitSCMSource.
protected boolean	isCategoryEnabled(jenkins.scm.api.SCMHeadCategory category)
protected boolean	isExcluded(String branchName) Deprecated. use WildcardSCMSourceFilterTrait
protected GitSCMBuilder<?>	newBuilder(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMRevision revision) Instantiates a new GitSCMBuilder.
protected hudson.plugins.git.GitTool	resolveGitTool() Deprecated. use resolveGitTool(String).
protected hudson.plugins.git.GitTool	resolveGitTool(String gitTool) Deprecated. Use resolveGitTool(String, TaskListener) instead
protected hudson.plugins.git.GitTool	resolveGitTool(String gitTool, TaskListener listener)
protected jenkins.scm.api.SCMRevision	retrieve(jenkins.scm.api.SCMHead head, TaskListener listener)
protected void	retrieve(jenkins.scm.api.SCMSourceCriteria criteria, jenkins.scm.api.SCMHeadObserver observer, jenkins.scm.api.SCMHeadEvent<?> event, TaskListener listener)
protected jenkins.scm.api.SCMRevision	retrieve(String revision, TaskListener listener, Item retrieveContext)
protected List<Action>	retrieveActions(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMHeadEvent event, TaskListener listener)
protected List<Action>	retrieveActions(jenkins.scm.api.SCMSourceEvent event, TaskListener listener)
protected Set<String>	retrieveRevisions(TaskListener listener, Item retrieveContext)

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, getTrustedRevision, hashCode, hasId, newProbe, parentHeads, parentRevisions, retrieve, retrieve, retrieve, retrieve, retrieve, retrieveActions, retrieveRevisions, setId, setOwner, setTraits, toString, withId

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REMOTE_NAME

public static final String DEFAULT_REMOTE_NAME

The default remote name to use when configuring the ref specs to use with fetch operations.

Since:

3.4.0

See Also:

Constant Field Values

REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR

public static final String REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR

The placeholder to use in ref spec templates in order to correctly ensure that the ref spec remote name matches the remote name.

The template uses @{...} as that is an illegal sequence in a remote name

Since:

3.4.0

See Also:

git source code rules on ref spec names, Constant Field Values

REF_SPEC_REMOTE_NAME_PLACEHOLDER

public static final String REF_SPEC_REMOTE_NAME_PLACEHOLDER

The regex for REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR.

Since:

3.4.0

REF_SPEC_DEFAULT

public static final String REF_SPEC_DEFAULT

The default ref spec template.

Since:

3.4.0

See Also:

Constant Field Values

Constructor Detail

AbstractGitSCMSource

public AbstractGitSCMSource()

AbstractGitSCMSource

@Deprecated
public AbstractGitSCMSource(String id)

Deprecated.

Method Detail

getCredentialsId

@CheckForNull
public abstract String getCredentialsId()

getRemote

public abstract String getRemote()

Returns:

Git remote URL

getIncludes

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="3.4.0")
public String getIncludes()

Deprecated. use WildcardSCMSourceFilterTrait

Returns:

the includes.

getExcludes

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="3.4.0")
public String getExcludes()

Deprecated. use WildcardSCMSourceFilterTrait

Returns:

the excludes.

getBrowser

@CheckForNull
 @Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="3.4.0")
public GitRepositoryBrowser getBrowser()

Deprecated. use GitBrowserSCMSourceTrait

Gets GitRepositoryBrowser to be used with this SCMSource.

Returns:

Repository browser or null if the default tool should be used.

Since:

2.5.1

getGitTool

@CheckForNull
 @Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="3.4.0")
public String getGitTool()

Deprecated. use GitToolSCMSourceTrait

Gets Git tool to be used for this SCM Source.

Returns:

Git Tool or null if the default tool should be used.

Since:

2.5.1

getExtensions

@NonNull
 @Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="3.4.0")
public List<GitSCMExtension> getExtensions()

Deprecated. use corresponding GitSCMExtensionTrait (and if there isn't one then likely the GitSCMExtension is not appropriate to use in the context of a SCMSource)

Gets list of extensions, which should be used with this branch source.

Returns:

List of Extensions to be used. May be empty

Since:

2.5.1

getTraits

@NonNull
public List<jenkins.scm.api.trait.SCMSourceTrait> getTraits()

Returns the SCMSourceTrait instances for this AbstractGitSCMSource.

Overrides:

getTraits in class jenkins.scm.api.SCMSource

Returns:

the SCMSourceTrait instances

Since:

3.4.0

getRemoteName

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="3.4.0")
public String getRemoteName()

Deprecated. use RemoteNameSCMSourceTrait

Returns:

the remote name.

resolveGitTool

@CheckForNull
 @Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
 @RestrictedSince(value="3.4.0")
protected hudson.plugins.git.GitTool resolveGitTool()

Deprecated. use resolveGitTool(String).

Resolves the GitTool.

Returns:

the GitTool.

resolveGitTool

@CheckForNull
 @Deprecated
protected hudson.plugins.git.GitTool resolveGitTool(String gitTool)

Deprecated. Use resolveGitTool(String, TaskListener) instead

Resolves the GitTool.

Parameters:

gitTool - the ToolInstallation.getName() to resolve.

Returns:

the GitTool

Since:

3.4.0

resolveGitTool

protected hudson.plugins.git.GitTool resolveGitTool(String gitTool,
                                                    TaskListener listener)

retrieve

@CheckForNull
protected jenkins.scm.api.SCMRevision retrieve(@NonNull
                                                             jenkins.scm.api.SCMHead head,
                                                             @NonNull
                                                             TaskListener listener)
                                                      throws IOException,
                                                             InterruptedException

Overrides:

retrieve in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

retrieve

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

Specified by:

retrieve in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

retrieve

@CheckForNull
protected jenkins.scm.api.SCMRevision retrieve(@NonNull
                                                             String revision,
                                                             @NonNull
                                                             TaskListener listener,
                                                             @CheckForNull
                                                             Item retrieveContext)
                                                      throws IOException,
                                                             InterruptedException

Overrides:

retrieve in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

retrieveRevisions

@NonNull
protected Set<String> retrieveRevisions(@NonNull
                                                 TaskListener listener,
                                                 @CheckForNull
                                                 Item retrieveContext)
                                          throws IOException,
                                                 InterruptedException

Overrides:

retrieveRevisions in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

retrieveActions

@NonNull
protected List<Action> retrieveActions(@CheckForNull
                                                jenkins.scm.api.SCMSourceEvent event,
                                                @NonNull
                                                TaskListener listener)
                                         throws IOException,
                                                InterruptedException

Overrides:

retrieveActions in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

retrieveActions

@NonNull
protected List<Action> retrieveActions(@NonNull
                                                jenkins.scm.api.SCMHead head,
                                                @CheckForNull
                                                jenkins.scm.api.SCMHeadEvent event,
                                                @NonNull
                                                TaskListener listener)
                                         throws IOException,
                                                InterruptedException

Overrides:

retrieveActions in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

isCategoryEnabled

protected boolean isCategoryEnabled(@NonNull
                                    jenkins.scm.api.SCMHeadCategory category)

Overrides:

isCategoryEnabled in class jenkins.scm.api.SCMSource

getCacheEntry

protected String getCacheEntry()

getCacheDir

protected static File getCacheDir(String cacheEntry)

getCacheDir

protected static File getCacheDir(String cacheEntry,
                                  boolean createDirectory)

getCacheLock

protected static Lock getCacheLock(String cacheEntry)

getCredentials

@CheckForNull
protected com.cloudbees.plugins.credentials.common.StandardUsernameCredentials getCredentials()

getRefSpecs

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="3.4.0")
protected List<org.eclipse.jgit.transport.RefSpec> getRefSpecs()

Deprecated. use RefSpecsSCMSourceTrait

Returns:

the ref specs.

newBuilder

protected GitSCMBuilder<?> newBuilder(@NonNull
                                      jenkins.scm.api.SCMHead head,
                                      @CheckForNull
                                      jenkins.scm.api.SCMRevision revision)

Instantiates a new GitSCMBuilder. Subclasses should override this method if they want to use a custom GitSCMBuilder or if they need to pre-decorate the builder.

Parameters:

head - the SCMHead.

revision - the SCMRevision.

Returns:

the GitSCMBuilder

See Also:

for post-decoration.

decorate

protected void decorate(GitSCMBuilder<?> builder)

Performs final decoration of the GitSCMBuilder. This method is called by build(SCMHead, SCMRevision) immediately prior to returning GitSCMBuilder.build(). Subclasses should override this method if they need to overrule builder behaviours defined by traits.

Parameters:

builder - the builder to decorate.

build

@NonNull
public SCM build(@NonNull
                          jenkins.scm.api.SCMHead head,
                          @CheckForNull
                          jenkins.scm.api.SCMRevision revision)

Specified by:

build in class jenkins.scm.api.SCMSource

getRemoteConfigs

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
 @RestrictedSince(value="3.4.0")
protected List<UserRemoteConfig> getRemoteConfigs()

Deprecated. use GitSCMBuilder.asRemoteConfigs()

Returns:

the UserRemoteConfig instances.

isExcluded

@Deprecated
 @Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
 @RestrictedSince(value="3.4.0")
protected boolean isExcluded(String branchName)

Deprecated. use WildcardSCMSourceFilterTrait

Returns true if the branchName isn't matched by includes or is matched by excludes.

Parameters:

branchName - name of branch to be tested

Returns:

true if branchName is excluded or is not included