Package io.superstudios.plugins.diversion

Class DiversionSCM

java.lang.Object

hudson.scm.SCM

io.superstudios.plugins.diversion.DiversionSCM

All Implemented Interfaces:

ExtensionPoint, Describable<SCM>

public class DiversionSCM
extends SCM

Jenkins SCM implementation for Diversion repositories. This SCM allows Jenkins to checkout files from Diversion repositories using the Diversion API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiversionSCM.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor	Description
DiversionSCM(String repositoryId, String credentialsId)

Method Summary

Modifier and Type	Method	Description
SCMRevisionState	calcRevisionsFromBuild(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
void	checkout(Run<?,?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline)
PollingResult	compareRemoteRevisionWith(Job<?,?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline)	Compare the remote repository state with the last built revision.
ChangeLogParser	createChangeLogParser()
String	getBranch()
String	getCredentialsId()
String	getLibraryPath()
String	getRepositoryId()
String	getScriptPath()
boolean	requiresWorkspaceForPolling()	Tell Jenkins we don't need a workspace for polling.
void	setBranch(String branch)
void	setLibraryPath(String libraryPath)
void	setScriptPath(String scriptPath)
boolean	supportsPolling()	Tell Jenkins we support polling.

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvironment, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getDescriptor, getEffectiveBrowser, getKey, 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

Constructor Details

DiversionSCM

@DataBoundConstructor
public DiversionSCM(String repositoryId,
 String credentialsId)

Method Details

setBranch

@DataBoundSetter
public void setBranch(String branch)

setScriptPath

@DataBoundSetter
public void setScriptPath(String scriptPath)

setLibraryPath

@DataBoundSetter
public void setLibraryPath(String libraryPath)

getRepositoryId

public String getRepositoryId()

getCredentialsId

public String getCredentialsId()

getBranch

public String getBranch()

getScriptPath

public String getScriptPath()

getLibraryPath

public String getLibraryPath()

checkout

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

Overrides:

checkout in class SCM

Throws:

IOException

InterruptedException

calcRevisionsFromBuild

public SCMRevisionState calcRevisionsFromBuild(@NonNull
 Run<?,?> build,
 @NonNull
 FilePath workspace,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
                                        throws IOException,
InterruptedException

Overrides:

calcRevisionsFromBuild in class SCM

Throws:

IOException

InterruptedException

compareRemoteRevisionWith

public PollingResult compareRemoteRevisionWith(@NonNull
 Job<?,?> project,
 @CheckForNull
 Launcher launcher,
 @CheckForNull
 FilePath workspace,
 @NonNull
 TaskListener listener,
 @NonNull
 SCMRevisionState baseline)
                                        throws IOException,
InterruptedException

Compare the remote repository state with the last built revision. This is the core method called during SCM polling to detect changes.

Overrides:

compareRemoteRevisionWith in class SCM

Parameters:

project - The job being polled

launcher - The launcher

workspace - The workspace (may be null for lightweight checkout)

listener - For logging

baseline - The revision state from the last build

Returns:

PollingResult indicating whether changes were found

Throws:

IOException

InterruptedException

supportsPolling

public boolean supportsPolling()

Tell Jenkins we support polling.

Overrides:

supportsPolling in class SCM

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Tell Jenkins we don't need a workspace for polling. We only need API access to check for new commits.

Overrides:

requiresWorkspaceForPolling in class SCM

createChangeLogParser

public ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class SCM