hudson.scm

Class SurroundStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

org.jenkinsci.plugins.workflow.steps.scm.SCMStep

hudson.scm.SurroundStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable

public class SurroundStep
extends org.jenkinsci.plugins.workflow.steps.scm.SCMStep

Runs Surround SCM using SurroundSCM

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SurroundStep.DescriptorImpl

Nested classes/interfaces inherited from class org.jenkinsci.plugins.workflow.steps.scm.SCMStep

org.jenkinsci.plugins.workflow.steps.scm.SCMStep.SCMStepDescriptor, org.jenkinsci.plugins.workflow.steps.scm.SCMStep.StepExecutionImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
SurroundStep(String url, String credentialsId)

Method Summary

Modifier and Type	Method and Description
protected hudson.scm.SCM	createSCM()
com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	getCredentials(hudson.model.Job<?,?> owner, hudson.EnvVars env)
String	getCredentialsId()
org.jenkinsci.plugins.plaincredentials.FileCredentials	getFileCredentials(hudson.model.Job<?,?> owner, hudson.EnvVars env)
RSAKey	getRsaKey() So...
String	getRsaKeyFileId()
String	getRsaKeyFilePath()
String	getUrl()
boolean	hasRsaKeyConfigured()
boolean	isUsingRsaKeyFileId()
boolean	isUsingRsaKeyPath()
void	setRsaKey(RSAKey rsaKey)
void	setRsaKeyFileId(String rsaKeyFileId)
void	setRsaKeyFilePath(String rsaKeyFilePath)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.scm.SCMStep

checkout, isChangelog, isPoll, setChangelog, setPoll

Methods inherited from class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

prepareInjector, start

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

SurroundStep

@DataBoundConstructor
public SurroundStep(String url,
                                           String credentialsId)

Method Detail

setRsaKeyFileId

@DataBoundSetter
public void setRsaKeyFileId(String rsaKeyFileId)

setRsaKeyFilePath

@DataBoundSetter
public void setRsaKeyFilePath(String rsaKeyFilePath)

setRsaKey

@DataBoundSetter
public void setRsaKey(RSAKey rsaKey)

createSCM

@Nonnull
protected hudson.scm.SCM createSCM()

Specified by:

createSCM in class org.jenkinsci.plugins.workflow.steps.scm.SCMStep

hasRsaKeyConfigured

@Exported
public boolean hasRsaKeyConfigured()

isUsingRsaKeyPath

@Exported
public boolean isUsingRsaKeyPath()

isUsingRsaKeyFileId

@Exported
public boolean isUsingRsaKeyFileId()

getUrl

@Exported
public String getUrl()

getCredentialsId

@Exported
public String getCredentialsId()

getRsaKey

@Exported
public RSAKey getRsaKey()

So... the RSA key combobox requires we use an RSAKey object, however forcing users to define an RSA key object for pipelines is annoying as hell.

Returns:

Always returns null to prevent this from showing up in the Snippet Generator

getRsaKeyFilePath

@Exported
public String getRsaKeyFilePath()

getRsaKeyFileId

@Exported
public String getRsaKeyFileId()

getCredentials

@Exported
 @CheckForNull
public com.cloudbees.plugins.credentials.common.StandardUsernameCredentials getCredentials(hudson.model.Job<?,?> owner,
                                                                                                                      hudson.EnvVars env)

getFileCredentials

@Exported
 @CheckForNull
public org.jenkinsci.plugins.plaincredentials.FileCredentials getFileCredentials(hudson.model.Job<?,?> owner,
                                                                                                            hudson.EnvVars env)