Package org.jenkinsci.plugins.github_branch_source

Class SSHCheckoutTrait

java.lang.Object

hudson.model.AbstractDescribableImpl<T>

jenkins.scm.api.trait.SCMTrait<jenkins.scm.api.trait.SCMSourceTrait>

jenkins.scm.api.trait.SCMSourceTrait

org.jenkinsci.plugins.github_branch_source.SSHCheckoutTrait

All Implemented Interfaces:

ExtensionPoint, Describable<jenkins.scm.api.trait.SCMSourceTrait>

public class SSHCheckoutTrait
extends jenkins.scm.api.trait.SCMSourceTrait

A SCMSourceTrait for GitHubSCMSource that causes the GitSCM checkout to be performed using a SSH private key rather than the GitHub username password credentials used for scanning / indexing.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SSHCheckoutTrait.DescriptorImpl	Our descriptor.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
SSHCheckoutTrait(String credentialsId)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	decorateBuilder(jenkins.scm.api.trait.SCMBuilder<?,?> builder)
final String	getCredentialsId()	Returns the configured credentials id.

Methods inherited from class jenkins.scm.api.trait.SCMSourceTrait

_for, _for, all, applyToBuilder, applyToContext, applyToObserver, decorateContext, decorateObserver, getDescriptor, includeCategory, isCategoryEnabled

Methods inherited from class jenkins.scm.api.trait.SCMTrait

asSetList, asSetList, find

Methods inherited from class java.lang.Object

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

Constructor Details

SSHCheckoutTrait

@DataBoundConstructor
public SSHCheckoutTrait(@CheckForNull
 String credentialsId)

Constructor.

Parameters:

credentialsId - the IdCredentials.getId() of the credentials to use or GitHubSCMSource.DescriptorImpl.ANONYMOUS to defer to the agent configured credentials (typically anonymous but not always)

Method Details

getCredentialsId

@CheckForNull
public final String getCredentialsId()

Returns the configured credentials id.

Returns:

the configured credentials id or null to use the build agent's key.

decorateBuilder

protected void decorateBuilder(jenkins.scm.api.trait.SCMBuilder<?,?> builder)

Overrides:

decorateBuilder in class jenkins.scm.api.trait.SCMSourceTrait