Package org.jenkinsci.plugins.github_branch_source

Class GitHubSCMNavigator

java.lang.Object

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

jenkins.scm.api.SCMNavigator

org.jenkinsci.plugins.github_branch_source.GitHubSCMNavigator

All Implemented Interfaces:

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

public class GitHubSCMNavigator
extends jenkins.scm.api.SCMNavigator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubSCMNavigator.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class jenkins.scm.api.SCMNavigator

PRONOUN

Constructor Summary

Constructors

Constructor	Description
GitHubSCMNavigator(String repoOwner)	Constructor.
GitHubSCMNavigator(String apiUri, String repoOwner, String scanCredentialsId, String checkoutCredentialsId)	Deprecated. use GitHubSCMNavigator(String), setApiUri(String), setCredentialsId(String) and SSHCheckoutTrait

Method Summary

Modifier and Type	Method	Description
void	afterSave(jenkins.scm.api.SCMNavigatorOwner owner)
String	getApiUri()	Gets the API endpoint for the GitHub server.
boolean	getBuildForkPRHead()	Deprecated. use ForkPullRequestDiscoveryTrait.getStrategies()
boolean	getBuildForkPRMerge()	Deprecated. use ForkPullRequestDiscoveryTrait.getStrategies()
boolean	getBuildOriginBranch()	Deprecated. use BranchDiscoveryTrait
boolean	getBuildOriginBranchWithPR()	Deprecated. use BranchDiscoveryTrait
boolean	getBuildOriginPRHead()	Deprecated. use OriginPullRequestDiscoveryTrait.getStrategies()
boolean	getBuildOriginPRMerge()	Deprecated. use OriginPullRequestDiscoveryTrait.getStrategies()
String	getCheckoutCredentialsId()	Deprecated. use SSHCheckoutTrait
String	getCredentialsId()	Gets the IdCredentials.getId() of the credentials to use when accessing apiUri (and also the default credentials to use for checking out).
String	getExcludes()	Deprecated. use WildcardSCMHeadFilterTrait.
String	getIncludes()	Deprecated. use WildcardSCMHeadFilterTrait.
String	getPattern()	Deprecated. use RegexSCMSourceFilterTrait
String	getRepoOwner()	Gets the name of the owner who's repositories will be navigated.
String	getScanCredentialsId()	Deprecated. use getCredentialsId().
List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>>	getTraits()	Gets the behavioural traits that are applied to this navigator and any GitHubSCMSource instances it discovers.
protected String	id()
static void	invalidatePrivateModeCache()
boolean	isEnableAvatar()	Return if the avatar retrieval is enabled.
List<Action>	retrieveActions(jenkins.scm.api.SCMNavigatorOwner owner, jenkins.scm.api.SCMNavigatorEvent event, TaskListener listener)
void	setApiUri(String apiUri)	Sets the API endpoint for the GitHub server.
void	setBuildForkPRHead(boolean buildForkPRHead)	Deprecated. use ForkPullRequestDiscoveryTrait
void	setBuildForkPRMerge(boolean buildForkPRMerge)	Deprecated. use ForkPullRequestDiscoveryTrait
void	setBuildOriginBranch(boolean buildOriginBranch)	Deprecated. use BranchDiscoveryTrait
void	setBuildOriginBranchWithPR(boolean buildOriginBranchWithPR)	Deprecated. use BranchDiscoveryTrait
void	setBuildOriginPRHead(boolean buildOriginPRHead)	Deprecated. use OriginPullRequestDiscoveryTrait
void	setBuildOriginPRMerge(boolean buildOriginPRMerge)	Deprecated. use OriginPullRequestDiscoveryTrait
void	setCredentialsId(String credentialsId)	Sets the IdCredentials.getId() of the credentials to use when accessing apiUri (and also the default credentials to use for checking out).
void	setEnableAvatar(boolean enableAvatar)	Enable retrieval of the organization avatar.
void	setExcludes(String excludes)	Deprecated. use WildcardSCMHeadFilterTrait.
void	setIncludes(String includes)	Deprecated. use WildcardSCMHeadFilterTrait.
void	setPattern(String pattern)	Deprecated. use RegexSCMSourceFilterTrait
void	setScanCredentialsId(String scanCredentialsId)	Deprecated. use setCredentialsId(String)
void	setTraits(List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> traits)	Sets the behavioural traits that are applied to this navigator and any GitHubSCMSource instances it discovers.
void	setTraits(jenkins.scm.api.trait.SCMTrait[] traits)	Sets the behavioural traits that are applied to this navigator and any GitHubSCMSource instances it discovers.
void	visitSource(String sourceName, jenkins.scm.api.SCMSourceObserver observer)
void	visitSources(jenkins.scm.api.SCMSourceObserver observer)

Methods inherited from class jenkins.scm.api.SCMNavigator

checkInterrupt, defaultListener, fetchActions, getCategories, getDescriptor, getId, getPronoun, isCategoryEnabled, resetId, visitSources, visitSources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitHubSCMNavigator

@DataBoundConstructor
public GitHubSCMNavigator(String repoOwner)

Constructor.

Parameters:

repoOwner - the owner of the repositories to navigate.

Since:

2.2.0

GitHubSCMNavigator

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public GitHubSCMNavigator(String apiUri,
                          String repoOwner,
                          String scanCredentialsId,
                          String checkoutCredentialsId)

Deprecated.

use GitHubSCMNavigator(String), setApiUri(String), setCredentialsId(String) and SSHCheckoutTrait

Legacy constructor.

Parameters:

apiUri - the API endpoint for the GitHub server.

repoOwner - the owner of the repositories to navigate.

scanCredentialsId - the credentials to use when accessing apiUri (and also the default credentials to use for checking out).

checkoutCredentialsId - the credentials to use when checking out.

Method Detail

getApiUri

@CheckForNull
public String getApiUri()

Gets the API endpoint for the GitHub server.

Returns:

the API endpoint for the GitHub server.

setApiUri

@DataBoundSetter
public void setApiUri(String apiUri)

Sets the API endpoint for the GitHub server.

Parameters:

apiUri - the API endpoint for the GitHub server.

Since:

2.2.0

getCredentialsId

@CheckForNull
public String getCredentialsId()

Gets the IdCredentials.getId() of the credentials to use when accessing apiUri (and also the default credentials to use for checking out).

Returns:

the IdCredentials.getId() of the credentials to use when accessing apiUri (and also the default credentials to use for checking out).

Since:

2.2.0

setCredentialsId

@DataBoundSetter
public void setCredentialsId(@CheckForNull
                             String credentialsId)

Sets the IdCredentials.getId() of the credentials to use when accessing apiUri (and also the default credentials to use for checking out).

Parameters:

credentialsId - the IdCredentials.getId() of the credentials to use when accessing apiUri (and also the default credentials to use for checking out).

Since:

2.2.0

isEnableAvatar

@NonNull
public boolean isEnableAvatar()

Return if the avatar retrieval is enabled.

Returns:

true is enabled, false otherwise

setEnableAvatar

@DataBoundSetter
public void setEnableAvatar(boolean enableAvatar)

Enable retrieval of the organization avatar.

Parameters:

enableAvatar - true to enable, false to disable

getRepoOwner

@NonNull
public String getRepoOwner()

Gets the name of the owner who's repositories will be navigated.

Returns:

the name of the owner who's repositories will be navigated.

getTraits

@NonNull
public List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> getTraits()

Gets the behavioural traits that are applied to this navigator and any GitHubSCMSource instances it discovers.

Overrides:

getTraits in class jenkins.scm.api.SCMNavigator

Returns:

the behavioural traits.

setTraits

@DataBoundSetter
public void setTraits(@CheckForNull
                      jenkins.scm.api.trait.SCMTrait[] traits)

Sets the behavioural traits that are applied to this navigator and any GitHubSCMSource instances it discovers. The new traits will take affect on the next navigation through any of the visitSources(SCMSourceObserver) overloads or visitSource(String, SCMSourceObserver).

Parameters:

traits - the new behavioural traits.

setTraits

public void setTraits(@CheckForNull
                      List<jenkins.scm.api.trait.SCMTrait<? extends jenkins.scm.api.trait.SCMTrait<?>>> traits)

Sets the behavioural traits that are applied to this navigator and any GitHubSCMSource instances it discovers. The new traits will take affect on the next navigation through any of the visitSources(SCMSourceObserver) overloads or visitSource(String, SCMSourceObserver).

Overrides:

setTraits in class jenkins.scm.api.SCMNavigator

Parameters:

traits - the new behavioural traits.

getScanCredentialsId

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@CheckForNull
public String getScanCredentialsId()

Deprecated.

use getCredentialsId().

Legacy getter.

Returns:

getCredentialsId().

setScanCredentialsId

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setScanCredentialsId(@CheckForNull
                                 String scanCredentialsId)

Deprecated.

use setCredentialsId(String)

Legacy setter.

Parameters:

scanCredentialsId - the credentials.

getIncludes

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@NonNull
public String getIncludes()

Deprecated.

use WildcardSCMHeadFilterTrait.

Legacy getter.

Returns:

WildcardSCMHeadFilterTrait.getIncludes()

getExcludes

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@NonNull
public String getExcludes()

Deprecated.

use WildcardSCMHeadFilterTrait.

Legacy getter.

Returns:

WildcardSCMHeadFilterTrait.getExcludes()

setIncludes

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setIncludes(@NonNull
                        String includes)

Deprecated.

use WildcardSCMHeadFilterTrait.

Legacy setter.

Parameters:

includes - see WildcardSCMHeadFilterTrait(String, String)

setExcludes

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setExcludes(@NonNull
                        String excludes)

Deprecated.

use WildcardSCMHeadFilterTrait.

Legacy setter.

Parameters:

excludes - see WildcardSCMHeadFilterTrait(String, String)

getBuildOriginBranch

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public boolean getBuildOriginBranch()

Deprecated.

use BranchDiscoveryTrait

Legacy getter.

Returns:

BranchDiscoveryTrait.isBuildBranch().

setBuildOriginBranch

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setBuildOriginBranch(boolean buildOriginBranch)

Deprecated.

use BranchDiscoveryTrait

Legacy setter.

Parameters:

buildOriginBranch - see BranchDiscoveryTrait(boolean, boolean).

getBuildOriginBranchWithPR

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public boolean getBuildOriginBranchWithPR()

Deprecated.

use BranchDiscoveryTrait

Legacy getter.

Returns:

BranchDiscoveryTrait.isBuildBranchesWithPR().

setBuildOriginBranchWithPR

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setBuildOriginBranchWithPR(boolean buildOriginBranchWithPR)

Deprecated.

use BranchDiscoveryTrait

Legacy setter.

Parameters:

buildOriginBranchWithPR - see BranchDiscoveryTrait(boolean, boolean).

getBuildOriginPRMerge

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public boolean getBuildOriginPRMerge()

Deprecated.

use OriginPullRequestDiscoveryTrait.getStrategies()

Legacy getter.

Returns:

OriginPullRequestDiscoveryTrait.getStrategies().

setBuildOriginPRMerge

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setBuildOriginPRMerge(boolean buildOriginPRMerge)

Deprecated.

use OriginPullRequestDiscoveryTrait

Legacy setter.

Parameters:

buildOriginPRMerge - see OriginPullRequestDiscoveryTrait(Set).

getBuildOriginPRHead

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public boolean getBuildOriginPRHead()

Deprecated.

use OriginPullRequestDiscoveryTrait.getStrategies()

Legacy getter.

Returns:

OriginPullRequestDiscoveryTrait.getStrategies().

setBuildOriginPRHead

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setBuildOriginPRHead(boolean buildOriginPRHead)

Deprecated.

use OriginPullRequestDiscoveryTrait

Legacy setter.

Parameters:

buildOriginPRHead - see OriginPullRequestDiscoveryTrait(Set).

getBuildForkPRMerge

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public boolean getBuildForkPRMerge()

Deprecated.

use ForkPullRequestDiscoveryTrait.getStrategies()

Legacy getter.

Returns:

ForkPullRequestDiscoveryTrait.getStrategies().

setBuildForkPRMerge

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setBuildForkPRMerge(boolean buildForkPRMerge)

Deprecated.

use ForkPullRequestDiscoveryTrait

Legacy setter.

Parameters:

buildForkPRMerge - see ForkPullRequestDiscoveryTrait(Set, SCMHeadAuthority).

getBuildForkPRHead

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public boolean getBuildForkPRHead()

Deprecated.

use ForkPullRequestDiscoveryTrait.getStrategies()

Legacy getter.

Returns:

ForkPullRequestDiscoveryTrait.getStrategies().

setBuildForkPRHead

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setBuildForkPRHead(boolean buildForkPRHead)

Deprecated.

use ForkPullRequestDiscoveryTrait

Legacy setter.

Parameters:

buildForkPRHead - see ForkPullRequestDiscoveryTrait(Set, SCMHeadAuthority).

getCheckoutCredentialsId

@CheckForNull
@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public String getCheckoutCredentialsId()

Deprecated.

use SSHCheckoutTrait

Legacy getter.

Returns:

SSHCheckoutTrait.getCredentialsId() with some mangling to preserve legacy behaviour.

getPattern

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
public String getPattern()

Deprecated.

use RegexSCMSourceFilterTrait

Legacy getter.

Returns:

RegexSCMSourceFilterTrait.getRegex().

setPattern

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@RestrictedSince("2.2.0")
@DataBoundSetter
public void setPattern(String pattern)

Deprecated.

use RegexSCMSourceFilterTrait

Legacy setter.

Parameters:

pattern - see RegexSCMSourceFilterTrait(String).

id

@NonNull
protected String id()

Specified by:

id in class jenkins.scm.api.SCMNavigator

visitSources

public void visitSources(jenkins.scm.api.SCMSourceObserver observer)
                  throws IOException,
                         InterruptedException

Specified by:

visitSources in class jenkins.scm.api.SCMNavigator

Throws:

IOException

InterruptedException

visitSource

public void visitSource(String sourceName,
                        jenkins.scm.api.SCMSourceObserver observer)
                 throws IOException,
                        InterruptedException

Overrides:

visitSource in class jenkins.scm.api.SCMNavigator

Throws:

IOException

InterruptedException

retrieveActions

@NonNull
public List<Action> retrieveActions(@NonNull
                                    jenkins.scm.api.SCMNavigatorOwner owner,
                                    @CheckForNull
                                    jenkins.scm.api.SCMNavigatorEvent event,
                                    @NonNull
                                    TaskListener listener)
                             throws IOException,
                                    InterruptedException

Overrides:

retrieveActions in class jenkins.scm.api.SCMNavigator

Throws:

IOException

InterruptedException

invalidatePrivateModeCache

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Initializer(after=JOB_CONFIG_ADAPTED)
public static void invalidatePrivateModeCache()

afterSave

public void afterSave(@NonNull
                      jenkins.scm.api.SCMNavigatorOwner owner)

Overrides:

afterSave in class jenkins.scm.api.SCMNavigator