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:

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

Direct Known Subclasses:

GitSCMSource

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

Author:

Stephen Connolly

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 interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
AbstractGitSCMSource(String id)

Method Summary

Methods

Modifier and Type	Method and Description
hudson.scm.SCM	build(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMRevision revision)
GitRepositoryBrowser	getBrowser() Gets GitRepositoryBrowser to be used with this SCMSource.
protected static File	getCacheDir(String cacheEntry)
protected String	getCacheEntry()
protected static Lock	getCacheLock(String cacheEntry)
protected com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	getCredentials()
abstract String	getCredentialsId()
abstract String	getExcludes()
List<GitSCMExtension>	getExtensions() Gets list of extensions, which should be used with this branch source.
String	getGitTool() Gets Git tool to be used for this SCM Source.
abstract String	getIncludes()
protected abstract List<org.eclipse.jgit.transport.RefSpec>	getRefSpecs()
abstract String	getRemote()
protected List<UserRemoteConfig>	getRemoteConfigs()
String	getRemoteName()
protected boolean	isExcluded(String branchName) Returns true if the branchName isn't matched by includes or is matched by excludes.
protected hudson.plugins.git.GitTool	resolveGitTool()
protected void	retrieve(jenkins.scm.api.SCMHeadObserver observer, hudson.model.TaskListener listener)
protected jenkins.scm.api.SCMRevision	retrieve(jenkins.scm.api.SCMHead head, hudson.model.TaskListener listener)
protected jenkins.scm.api.SCMRevision	retrieve(String revision, hudson.model.TaskListener listener)
protected Set<String>	retrieveRevisions(hudson.model.TaskListener listener)

Methods inherited from class jenkins.scm.api.SCMSource

build, defaultListener, equals, fetch, fetch, fetch, fetch, fetchRevisions, getCriteria, getId, getOwner, getTrustedRevision, hashCode, parentHeads, parentRevisions, retrieve, setOwner, toString

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGitSCMSource

public AbstractGitSCMSource(String id)

Method Detail

getCredentialsId

@CheckForNull
public abstract String getCredentialsId()

getRemote

public abstract String getRemote()

getIncludes

public abstract String getIncludes()

getExcludes

public abstract String getExcludes()

getBrowser

@CheckForNull
public GitRepositoryBrowser getBrowser()

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
public String getGitTool()

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
public List<GitSCMExtension> getExtensions()

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

getRemoteName

public String getRemoteName()

resolveGitTool

@CheckForNull
protected hudson.plugins.git.GitTool resolveGitTool()

retrieve

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

Overrides:

retrieve in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

retrieve

@NonNull
protected void retrieve(@NonNull
                    jenkins.scm.api.SCMHeadObserver observer,
                    @NonNull
                    hudson.model.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
                                                hudson.model.TaskListener listener)
                                        throws IOException,
                                               InterruptedException

Overrides:

retrieve in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

retrieveRevisions

@CheckForNull
protected Set<String> retrieveRevisions(@NonNull
                                         hudson.model.TaskListener listener)
                                 throws IOException,
                                        InterruptedException

Overrides:

retrieveRevisions in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

getCacheEntry

protected String getCacheEntry()

getCacheDir

protected static File getCacheDir(String cacheEntry)

getCacheLock

protected static Lock getCacheLock(String cacheEntry)

getCredentials

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

getRefSpecs

protected abstract List<org.eclipse.jgit.transport.RefSpec> getRefSpecs()

build

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

Specified by:

build in class jenkins.scm.api.SCMSource

getRemoteConfigs

protected List<UserRemoteConfig> getRemoteConfigs()

isExcluded

protected boolean isExcluded(String branchName)

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

Parameters:

branchName - name of branch

Returns:

true if branchName is excluded or is not included