org.jenkinsci.plugins.github_branch_source

Class GitHubSCMSource

java.lang.Object

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

jenkins.scm.api.SCMSource

jenkins.plugins.git.AbstractGitSCMSource

org.jenkinsci.plugins.github_branch_source.GitHubSCMSource

All Implemented Interfaces:

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

public class GitHubSCMSource
extends jenkins.plugins.git.AbstractGitSCMSource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitHubSCMSource.DescriptorImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	GITHUB_URL
static String	VALID_GIT_SHA1
static String	VALID_GITHUB_REPO_NAME
static String	VALID_GITHUB_USER_NAME

Fields inherited from class jenkins.scm.api.SCMSource

PRONOUN

Constructor Summary

Constructors

Constructor and Description
GitHubSCMSource(String id, String apiUri, String checkoutCredentialsId, String scanCredentialsId, String repoOwner, String repository)

Method Summary

Modifier and Type	Method and Description
void	afterSave()
hudson.scm.SCM	build(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMRevision revision)
protected jenkins.scm.api.SCMProbe	createProbe(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMRevision revision)
protected jenkins.scm.api.SCMRevision	doRetrieve(jenkins.scm.api.SCMHead head, hudson.model.TaskListener listener, org.kohsuke.github.GHRepository repo)
String	getApiUri()
boolean	getBuildForkPRHead()
boolean	getBuildForkPRMerge()
boolean	getBuildOriginBranch()
boolean	getBuildOriginBranchWithPR()
boolean	getBuildOriginPRHead()
boolean	getBuildOriginPRMerge()
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
String	getExcludes()
String	getIncludes()
String	getPronoun()
protected List<org.eclipse.jgit.transport.RefSpec>	getRefSpecs()
String	getRemote()
String	getRepoOwner()
String	getRepository()
String	getScanCredentialsId()
jenkins.scm.api.SCMRevision	getTrustedRevision(jenkins.scm.api.SCMRevision revision, hudson.model.TaskListener listener)
RepositoryUriResolver	getUriResolver() Returns a RepositoryUriResolver according to credentials configuration.
protected boolean	isCategoryEnabled(jenkins.scm.api.SCMHeadCategory category)
protected boolean	isExcluded(String branchName)
protected jenkins.scm.api.SCMRevision	retrieve(jenkins.scm.api.SCMHead head, hudson.model.TaskListener listener)
protected void	retrieve(jenkins.scm.api.SCMSourceCriteria criteria, jenkins.scm.api.SCMHeadObserver observer, jenkins.scm.api.SCMHeadEvent<?> event, hudson.model.TaskListener listener)
protected List<hudson.model.Action>	retrieveActions(jenkins.scm.api.SCMHead head, jenkins.scm.api.SCMHeadEvent event, hudson.model.TaskListener listener)
protected List<hudson.model.Action>	retrieveActions(jenkins.scm.api.SCMSourceEvent event, hudson.model.TaskListener listener)
void	setBuildForkPRHead(boolean buildForkPRHead)
void	setBuildForkPRMerge(boolean buildForkPRMerge)
void	setBuildOriginBranch(boolean buildOriginBranch)
void	setBuildOriginBranchWithPR(boolean buildOriginBranchWithPR)
void	setBuildOriginPRHead(boolean buildOriginPRHead)
void	setBuildOriginPRMerge(boolean buildOriginPRMerge)
void	setExcludes(String excludes)
void	setIncludes(String includes)

Methods inherited from class jenkins.plugins.git.AbstractGitSCMSource

getCacheDir, getCacheEntry, getCacheLock, getCredentials, getRemoteConfigs, getRemoteName, retrieve

Methods inherited from class jenkins.scm.api.SCMSource

build, canProbe, checkInterrupt, defaultListener, equals, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetchActions, fetchActions, fetchActions, fetchRevisions, fromSCMFileSystem, getCategories, getCriteria, getDescriptor, getId, getOwner, hashCode, newProbe, parentHeads, parentRevisions, retrieve, retrieve, retrieve, retrieve, retrieveActions, retrieveRevisions, setOwner, toString

Methods inherited from class java.lang.Object

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

Field Detail

VALID_GITHUB_REPO_NAME

public static final String VALID_GITHUB_REPO_NAME

See Also:

Constant Field Values

VALID_GITHUB_USER_NAME

public static final String VALID_GITHUB_USER_NAME

See Also:

Constant Field Values

VALID_GIT_SHA1

public static final String VALID_GIT_SHA1

See Also:

Constant Field Values

GITHUB_URL

public static final String GITHUB_URL

See Also:

Constant Field Values

Constructor Detail

GitHubSCMSource

@DataBoundConstructor
public GitHubSCMSource(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()

getPronoun

public String getPronoun()

Overrides:

getPronoun in class jenkins.scm.api.SCMSource

getRefSpecs

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

Specified by:

getRefSpecs in class jenkins.plugins.git.AbstractGitSCMSource

getUriResolver

public RepositoryUriResolver getUriResolver()

Returns a RepositoryUriResolver according to credentials configuration.

Returns:

a RepositoryUriResolver

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)

getBuildOriginBranch

public boolean getBuildOriginBranch()

setBuildOriginBranch

@DataBoundSetter
public void setBuildOriginBranch(boolean buildOriginBranch)

getBuildOriginBranchWithPR

public boolean getBuildOriginBranchWithPR()

setBuildOriginBranchWithPR

@DataBoundSetter
public void setBuildOriginBranchWithPR(boolean buildOriginBranchWithPR)

getBuildOriginPRMerge

public boolean getBuildOriginPRMerge()

setBuildOriginPRMerge

@DataBoundSetter
public void setBuildOriginPRMerge(boolean buildOriginPRMerge)

getBuildOriginPRHead

public boolean getBuildOriginPRHead()

setBuildOriginPRHead

@DataBoundSetter
public void setBuildOriginPRHead(boolean buildOriginPRHead)

getBuildForkPRMerge

public boolean getBuildForkPRMerge()

setBuildForkPRMerge

@DataBoundSetter
public void setBuildForkPRMerge(boolean buildForkPRMerge)

getBuildForkPRHead

public boolean getBuildForkPRHead()

setBuildForkPRHead

@DataBoundSetter
public void setBuildForkPRHead(boolean buildForkPRHead)

getRemote

public String getRemote()

Specified by:

getRemote in class jenkins.plugins.git.AbstractGitSCMSource

retrieve

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

Specified by:

retrieve in class jenkins.scm.api.SCMSource

Throws:

IOException

InterruptedException

isExcluded

protected boolean isExcluded(String branchName)

Overrides:

isExcluded in class jenkins.plugins.git.AbstractGitSCMSource

createProbe

@NonNull
protected jenkins.scm.api.SCMProbe createProbe(@NonNull
                                                        jenkins.scm.api.SCMHead head,
                                                        @CheckForNull
                                                        jenkins.scm.api.SCMRevision revision)
                                                 throws IOException

Overrides:

createProbe in class jenkins.scm.api.SCMSource

Throws:

IOException

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

build

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

Overrides:

build in class jenkins.plugins.git.AbstractGitSCMSource

getTrustedRevision

public jenkins.scm.api.SCMRevision getTrustedRevision(jenkins.scm.api.SCMRevision revision,
                                                      hudson.model.TaskListener listener)
                                               throws IOException,
                                                      InterruptedException

Overrides:

getTrustedRevision 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

retrieveActions

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

Overrides:

retrieveActions in class jenkins.scm.api.SCMSource

Throws:

IOException

retrieveActions

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

Overrides:

retrieveActions in class jenkins.scm.api.SCMSource

Throws:

IOException

afterSave

public void afterSave()

Overrides:

afterSave in class jenkins.scm.api.SCMSource