hudson.scm

Class SurroundSCM

java.lang.Object

hudson.scm.SCM

hudson.scm.SurroundSCM

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.SCM>

@Extension
public final class SurroundSCM
extends hudson.scm.SCM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SurroundSCM.SurroundSCMDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static SurroundSCM.SurroundSCMDescriptor	DESCRIPTOR Singleton descriptor.

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
SurroundSCM() Deprecated.
SurroundSCM(String server, String serverPort, String branch, String repository, String credentialsId)
SurroundSCM(String rsaKeyPath, String server, String serverPort, String userName, String password, String branch, String repository, String surroundSCMExecutable) Deprecated. Deprecated as of release v9, added option to include // exclude output.
SurroundSCM(String rsaKeyPath, String server, String serverPort, String userName, String password, String branch, String repository, String surroundSCMExecutable, boolean includeOutput) Deprecated. as of release v10, Significant updates to the Jenkins integration, including: - Switched to @DataBoundSetter's for optional parameters - Switched to Credential storage for usernames & rsakeys - Updated the config page, which necessitated data structure changes.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Calculates the SCMRevisionState that represents the state of the workspace of the given build.
void	checkout(hudson.model.Run<?,?> build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, File changelogFile, hudson.scm.SCMRevisionState baseline) Obtains a fresh workspace of the module(s) into the specified directory of the specified machine.
hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.Job<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState baseline)
hudson.scm.ChangeLogParser	createChangeLogParser()
String	getBranch()
String	getCredentialsId()
hudson.scm.SCMDescriptor<?>	getDescriptor()
boolean	getIncludeOutput()
String	getKey()
String	getPassword() Deprecated. Use getCredentialsId instead of this function. This was left in place to support legacy plugins that stored the username & password.
String	getRepository()
RSAKey	getRsaKey() This function was required to make the Snippet Generator work
String	getRsaKeyFileId() Used to populate the rsaKeyFileId field in stapler.
String	getRsaKeyFilePath() Used to populate the rsaKeyFilePath field in stapler.
String	getRsaKeyPath() Deprecated. This was getting called.... not entirely sure why, having it always return 'null' to indicate that the field is not being used. It was showing up in the 'Snippet Generator' for the 'checkout' command prior to me having this return null. When I didn't have this field, and it was not marked as @Exported the 'Snippet Generator' was throwing errors and wouldn't correctly generate the example 'checkout' command.
String	getServer()
String	getServerPort()
String	getUserName() Deprecated. Use getCredentialsId instead of this function. This was left in place to support legacy plugins that stored the username & password.
boolean	hasRsaKeyConfigured()
boolean	isUsingRsaKeyFileId()
boolean	isUsingRsaKeyPath()
boolean	requiresWorkspaceForPolling() We don't actually NEED a workspace for polling.
SurroundTool	resolveSscmTool(hudson.model.TaskListener listener) Attempt to find a pre-configured 'SurroundTool' with a saved 'sscm_tool_name' Currently this will always fall back to the 'default' tool for the current node and requires some further testing of edge conditions
void	setIncludeOutput(boolean includeOutput)
void	setRsaKey(RSAKey rsaKey)
void	setRsaKeyFileId(String rsaKeyFileId)
void	setRsaKeyFilePath(String rsaKeyFilePath)
void	setRsaKeyPath(String rsaKeyPath) Deprecated. Leaving this here for when reading in old versions of the plugin we can setup the new version of the rsaKey storage.
boolean	supportsPolling()

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getEffectiveBrowser, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

@Extension
public static final SurroundSCM.SurroundSCMDescriptor DESCRIPTOR

Singleton descriptor.

Constructor Detail

SurroundSCM

@DataBoundConstructor
public SurroundSCM(String server,
                                String serverPort,
                                String branch,
                                String repository,
                                String credentialsId)

SurroundSCM

public SurroundSCM(String rsaKeyPath,
           String server,
           String serverPort,
           String userName,
           String password,
           String branch,
           String repository,
           String surroundSCMExecutable,
           boolean includeOutput)

Deprecated. as of release v10, Significant updates to the Jenkins integration, including: - Switched to @DataBoundSetter's for optional parameters - Switched to Credential storage for usernames & rsakeys - Updated the config page, which necessitated data structure changes.

SurroundSCM

public SurroundSCM(String rsaKeyPath,
           String server,
           String serverPort,
           String userName,
           String password,
           String branch,
           String repository,
           String surroundSCMExecutable)

Deprecated. Deprecated as of release v9, added option to include // exclude output.

SurroundSCM

@Deprecated
public SurroundSCM()

Deprecated.

Method Detail

getUserName

public String getUserName()

Deprecated. Use getCredentialsId instead of this function. This was left in place to support legacy plugins that stored the username & password.

getPassword

public String getPassword()

Deprecated. Use getCredentialsId instead of this function. This was left in place to support legacy plugins that stored the username & password.

getRsaKeyFilePath

public String getRsaKeyFilePath()

Used to populate the rsaKeyFilePath field in stapler.

Returns:

If using an RSA key file path, returns the path, otherwise returns null.

setRsaKeyFilePath

@DataBoundSetter
public void setRsaKeyFilePath(String rsaKeyFilePath)

getRsaKeyFileId

public String getRsaKeyFileId()

Used to populate the rsaKeyFileId field in stapler.

Returns:

If using an RSA key file ID, returns the ID string, otherwise returns null.

setRsaKeyFileId

@DataBoundSetter
public void setRsaKeyFileId(String rsaKeyFileId)

getServer

@Exported
public String getServer()

getServerPort

@Exported
public String getServerPort()

getBranch

@Exported
public String getBranch()

getRepository

@Exported
public String getRepository()

getIncludeOutput

@Exported
public boolean getIncludeOutput()

setIncludeOutput

public void setIncludeOutput(boolean includeOutput)

getCredentialsId

public String getCredentialsId()

hasRsaKeyConfigured

@Exported
public boolean hasRsaKeyConfigured()

isUsingRsaKeyPath

@Exported
public boolean isUsingRsaKeyPath()

isUsingRsaKeyFileId

@Exported
public boolean isUsingRsaKeyFileId()

getRsaKey

@Exported
public RSAKey getRsaKey()

This function was required to make the Snippet Generator work

Returns:

Always returns null because we want users to use rsaKeyFileId: and rsaKeyFilePath:, not rsaKey: [type: "ID" value: "blah"]. When we actually returned the rsaKey here, it screwed w/ the the Snippet Generator.

setRsaKey

@DataBoundSetter
public void setRsaKey(RSAKey rsaKey)

getRsaKeyPath

@Exported
public String getRsaKeyPath()

Deprecated. This was getting called.... not entirely sure why, having it always return 'null' to indicate that the field is not being used. It was showing up in the 'Snippet Generator' for the 'checkout' command prior to me having this return null.

When I didn't have this field, and it was not marked as @Exported the 'Snippet Generator' was throwing errors and wouldn't correctly generate the example 'checkout' command.

Returns:

Returns 'null' to indicate that this is an un-used field.

setRsaKeyPath

@DataBoundSetter
public void setRsaKeyPath(String rsaKeyPath)

Deprecated. Leaving this here for when reading in old versions of the plugin we can setup the new version of the rsaKey storage.

Parameters:

rsaKeyPath - Path to the RSA key file on the remote node.

getDescriptor

public hudson.scm.SCMDescriptor<?> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.scm.SCM>

Overrides:

getDescriptor in class hudson.scm.SCM

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(@Nonnull
                                                 hudson.model.Run<?,?> build,
                                                 @Nullable
                                                 hudson.FilePath workspace,
                                                 @Nullable
                                                 hudson.Launcher launcher,
                                                 @Nonnull
                                                 hudson.model.TaskListener listener)
                                                   throws IOException,
                                                          InterruptedException

Calculates the SCMRevisionState that represents the state of the workspace of the given build. The returned object is then fed into the compareRemoteRevisionWith(AbstractProject, Launcher, FilePath, TaskListener, SCMRevisionState) method as the baseline SCMRevisionState to determine if the build is necessary.

Overrides:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

IOException

InterruptedException

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

We don't actually NEED a workspace for polling. We are saving our info to a system temp file, further the way we are currently working (saving the info to a system temp file) is a bit daft since we could just directly read the command output rather than saving it to a file. However, we have relied on this to be set to 'True' since we started coding, and when I tried to turn it off, stuff broke. Maybe we can try again later?

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

Returns:

Returns 'True'

supportsPolling

public boolean supportsPolling()

Overrides:

supportsPolling in class hudson.scm.SCM

compareRemoteRevisionWith

public hudson.scm.PollingResult compareRemoteRevisionWith(@Nonnull
                                                 hudson.model.Job<?,?> project,
                                                 @Nullable
                                                 hudson.Launcher launcher,
                                                 @Nullable
                                                 hudson.FilePath workspace,
                                                 @Nonnull
                                                 hudson.model.TaskListener listener,
                                                 @Nonnull
                                                 hudson.scm.SCMRevisionState baseline)
                                                   throws IOException,
                                                          InterruptedException

Overrides:

compareRemoteRevisionWith in class hudson.scm.SCM

Throws:

IOException

InterruptedException

checkout

public void checkout(@Nonnull
            hudson.model.Run<?,?> build,
            @Nonnull
            hudson.Launcher launcher,
            @Nonnull
            hudson.FilePath workspace,
            @Nonnull
            hudson.model.TaskListener listener,
            @CheckForNull
            File changelogFile,
            @CheckForNull
            hudson.scm.SCMRevisionState baseline)
              throws IOException,
                     InterruptedException

Obtains a fresh workspace of the module(s) into the specified directory of the specified machine. We'll use sscm get.

Overrides:

checkout in class hudson.scm.SCM

Throws:

IOException

InterruptedException

getKey

@Nonnull
public String getKey()

Overrides:

getKey in class hudson.scm.SCM

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

resolveSscmTool

public SurroundTool resolveSscmTool(hudson.model.TaskListener listener)

Attempt to find a pre-configured 'SurroundTool' with a saved 'sscm_tool_name' Currently this will always fall back to the 'default' tool for the current node and requires some further testing of edge conditions