org.jenkinsci.plugins.github_branch_source

Class AbstractGitHubSCMSource

java.lang.Object

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

jenkins.scm.api.SCMSource

jenkins.plugins.git.AbstractGitSCMSource

org.jenkinsci.plugins.github_branch_source.AbstractGitHubSCMSource

All Implemented Interfaces:

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

Direct Known Subclasses:

OriginGitHubSCMSource

public abstract class AbstractGitHubSCMSource
extends jenkins.plugins.git.AbstractGitSCMSource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractGitHubSCMSource.AbstractGitHubSCMSourceDescriptor

Nested classes/interfaces inherited from class jenkins.plugins.git.AbstractGitSCMSource

jenkins.plugins.git.AbstractGitSCMSource.SCMRevisionImpl, jenkins.plugins.git.AbstractGitSCMSource.SpecificRevisionBuildChooser

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGitHubSCMSource(String id, String apiUri, String checkoutCredentialsId, String scanCredentialsId, String repoOwner, String repository)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doRetrieve(jenkins.scm.api.SCMHeadObserver observer, hudson.model.TaskListener listener, org.kohsuke.github.GHRepository repo)
protected jenkins.scm.api.SCMRevision	doRetrieve(jenkins.scm.api.SCMHead head, hudson.model.TaskListener listener, org.kohsuke.github.GHRepository repo)
String	getApiUri()
String	getCheckoutCredentialsId()
String	getCredentialsId() Returns the effective credentials used to check out sources: null - anonymous access SAME - represents that we want to use the same as scan credentials UUID - represents the credentials identifier
AbstractGitHubSCMSource.AbstractGitHubSCMSourceDescriptor	getDescriptor()
String	getExcludes()
String	getIncludes()
protected jenkins.scm.api.SCMSourceCriteria.Probe	getProbe(String branch, String thing, String ref, org.kohsuke.github.GHRepository repo, hudson.model.TaskListener listener) Returns a SCMSourceCriteria.Probe for use in doRetrieve(jenkins.scm.api.SCMHeadObserver, hudson.model.TaskListener, org.kohsuke.github.GHRepository).
String	getRemote()
String	getRepoOwner()
String	getRepository()
String	getScanCredentialsId()
RepositoryUriResolver	getUriResolver() Returns a RepositoryUriResolver according to credentials configuration.
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)
void	setExcludes(String excludes)
void	setIncludes(String includes)

Methods inherited from class jenkins.plugins.git.AbstractGitSCMSource

build, getCacheDir, getCacheEntry, getCacheLock, getCredentials, getRefSpecs, getRemoteConfigs, getRemoteName, isExcluded

Methods inherited from class jenkins.scm.api.SCMSource

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGitHubSCMSource

protected AbstractGitHubSCMSource(String id,
                       String apiUri,
                       String checkoutCredentialsId,
                       String scanCredentialsId,
                       String repoOwner,
                       String repository)

Method Detail

getApiUri

@CheckForNull
public String getApiUri()

getCredentialsId

@CheckForNull
public String getCredentialsId()

Returns the effective credentials used to check out sources: null - anonymous access SAME - represents that we want to use the same as scan credentials UUID - represents the credentials identifier

Specified by:

getCredentialsId in class jenkins.plugins.git.AbstractGitSCMSource

Returns:

A string or null.

getScanCredentialsId

@CheckForNull
public String getScanCredentialsId()

getCheckoutCredentialsId

@CheckForNull
public String getCheckoutCredentialsId()

getRepoOwner

public String getRepoOwner()

getRepository

public String getRepository()

getUriResolver

public RepositoryUriResolver getUriResolver()

Returns a RepositoryUriResolver according to credentials configuration.

Returns:

a RepositoryUriResolver

getDescriptor

public AbstractGitHubSCMSource.AbstractGitHubSCMSourceDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<jenkins.scm.api.SCMSource>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<jenkins.scm.api.SCMSource>

getIncludes

@Nonnull
public String getIncludes()

Specified by:

getIncludes in class jenkins.plugins.git.AbstractGitSCMSource

setIncludes

@DataBoundSetter
public void setIncludes(@Nonnull
                               String includes)

getExcludes

@Nonnull
public String getExcludes()

Specified by:

getExcludes in class jenkins.plugins.git.AbstractGitSCMSource

setExcludes

@DataBoundSetter
public void setExcludes(@Nonnull
                               String excludes)

getRemote

public String getRemote()

Specified by:

getRemote in class jenkins.plugins.git.AbstractGitSCMSource

retrieve

protected final void retrieve(jenkins.scm.api.SCMHeadObserver observer,
            hudson.model.TaskListener listener)
                       throws IOException,
                              InterruptedException

Overrides:

retrieve in class jenkins.plugins.git.AbstractGitSCMSource

Throws:

IOException

InterruptedException

doRetrieve

protected abstract void doRetrieve(jenkins.scm.api.SCMHeadObserver observer,
              hudson.model.TaskListener listener,
              org.kohsuke.github.GHRepository repo)
                            throws IOException,
                                   InterruptedException

Throws:

IOException

InterruptedException

getProbe

protected jenkins.scm.api.SCMSourceCriteria.Probe getProbe(String branch,
                                               String thing,
                                               String ref,
                                               org.kohsuke.github.GHRepository repo,
                                               hudson.model.TaskListener listener)

Returns a SCMSourceCriteria.Probe for use in doRetrieve(jenkins.scm.api.SCMHeadObserver, hudson.model.TaskListener, org.kohsuke.github.GHRepository).

Parameters:

branch - branch name

thing - readable name of what this is, e.g. branch

ref - the refspec, e.g. refs/heads/myproduct-stable

repo - A repository on GitHub.

listener - A TaskListener to log useful information

Returns:

A SCMSourceCriteria.Probe

retrieve

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

Overrides:

retrieve in class jenkins.plugins.git.AbstractGitSCMSource

Throws:

IOException

InterruptedException

doRetrieve

protected jenkins.scm.api.SCMRevision doRetrieve(jenkins.scm.api.SCMHead head,
                                     hudson.model.TaskListener listener,
                                     org.kohsuke.github.GHRepository repo)
                                          throws IOException,
                                                 InterruptedException

Throws:

IOException

InterruptedException