hudson.plugins.dimensionsscm

Class DimensionsSCM

java.lang.Object

hudson.scm.SCM

hudson.plugins.dimensionsscm.DimensionsSCM

All Implemented Interfaces:

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

public class DimensionsSCM
extends hudson.scm.SCM
implements Serializable

An SCM that can poll, browse and update from Dimensions CM.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DimensionsSCM.DescriptorImpl Implementation class for Dimensions CM SCM plugin.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static DimensionsSCM.DescriptorImpl	DM_DESCRIPTOR

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description

DimensionsSCM(String project, String[] folders, String[] pathsToExclude, String workarea, boolean canJobDelete, boolean canJobForce, boolean canJobRevert, String jobUserName, String jobPasswd, String jobServer, String jobDatabase, boolean canJobUpdate, String jobTimeZone, String jobWebUrl, String directory, String permissions, String eol, boolean canJobExpand, boolean canJobNoMetadata, boolean canJobNoTouch, boolean forceAsSlave)

Method Summary

Methods

Modifier and Type	Method and Description
void	buildEnvVars(hudson.model.AbstractBuild<?,?> build, Map<String,String> env) Build up environment variables for build support.
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener) Has the repository had any changes since last build?
boolean	checkout(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.BuildListener listener, File changelogFile) Checkout method for the plugin.
protected hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.AbstractProject<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState baseline) Has the repository had any changes?
hudson.scm.ChangeLogParser	createChangeLogParser() Create a log parser object.
PathMatcher	createPathMatcher() Creates path matcher to ignore changes on certain paths.
DimensionsAPI	getAPI()
DimensionsSCMRepositoryBrowser	getBrowser()
DimensionsSCM.DescriptorImpl	getDescriptor() Return an SCM descriptor.
String	getDirectory() Gets the project path.
String	getEol() Gets the eol value.
String[]	getFolders() Gets the project paths to monitor.
String	getJobDatabase() Gets the database name for the connection.
String	getJobPasswd() Gets the password for the connection.
String	getJobServer() Gets the server name for the connection.
String	getJobTimeZone() Gets the time zone for the connection.
String	getJobUserName() Gets the user ID for the connection.
String	getJobWebUrl() Gets the web URL for the connection.
String[]	getPathsToExclude() Gets paths excluded from monitoring.
String	getPermissions() Gets the permissions string.
String	getProject() Gets the unexpanded project name for the connection.
String	getProjectName(hudson.model.Run<?,?> run, hudson.model.TaskListener log) Gets the expanded project name for the connection.
String	getProjectVersion(hudson.model.Run<?,?> run, hudson.model.TaskListener log) Gets the expanded project name and version for the connection.
boolean	isCanJobDelete() Gets the delete flag.
boolean	isCanJobExpand() Gets the expand flag.
boolean	isCanJobForce() Gets the force flag.
boolean	isCanJobNoMetadata() Gets the no metadata flag.
boolean	isCanJobNoTouch() Gets the no touch flag.
boolean	isCanJobRevert() Gets the revert flag.
boolean	isCanJobUpdate() Gets the update flag.
boolean	isForceAsSlave() Gets force as slave flag.
boolean	processWorkspaceBeforeDeletion(hudson.model.AbstractProject<?,?> project, hudson.FilePath workspace, hudson.model.Node node) Okay to clear the area?
boolean	requiresWorkspaceForPolling() Does this SCM plugin require a workspace for polling?
boolean	supportsPolling() Does this SCM plugin support polling?

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, all, createEmptyChangeLog, getApi, getEffectiveBrowser, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, nullify, poll, pollChanges, postCheckout

Methods inherited from class java.lang.Object

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

Field Detail

DM_DESCRIPTOR

@Extension
public static final DimensionsSCM.DescriptorImpl DM_DESCRIPTOR

Constructor Detail

DimensionsSCM

@DataBoundConstructor
public DimensionsSCM(String project,
                                  String[] folders,
                                  String[] pathsToExclude,
                                  String workarea,
                                  boolean canJobDelete,
                                  boolean canJobForce,
                                  boolean canJobRevert,
                                  String jobUserName,
                                  String jobPasswd,
                                  String jobServer,
                                  String jobDatabase,
                                  boolean canJobUpdate,
                                  String jobTimeZone,
                                  String jobWebUrl,
                                  String directory,
                                  String permissions,
                                  String eol,
                                  boolean canJobExpand,
                                  boolean canJobNoMetadata,
                                  boolean canJobNoTouch,
                                  boolean forceAsSlave)

Method Detail

getAPI

public DimensionsAPI getAPI()

getBrowser

public DimensionsSCMRepositoryBrowser getBrowser()

Overrides:

getBrowser in class hudson.scm.SCM

getProject

public String getProject()

Gets the unexpanded project name for the connection.

Returns:

the project spec

getProjectName

public String getProjectName(hudson.model.Run<?,?> run,
                    hudson.model.TaskListener log)

Gets the expanded project name for the connection. Any variables in the project value will be expanded.

Returns:

the project spec without a trailing version number (if there is one).

getProjectVersion

public String getProjectVersion(hudson.model.Run<?,?> run,
                       hudson.model.TaskListener log)

Gets the expanded project name and version for the connection. Any variables in the project value will be expanded.

Returns:

the project spec including its trailing version (if there is one).

getDirectory

public String getDirectory()

Gets the project path.

getPermissions

public String getPermissions()

Gets the permissions string.

getEol

public String getEol()

Gets the eol value.

getFolders

public String[] getFolders()

Gets the project paths to monitor.

getPathsToExclude

public String[] getPathsToExclude()

Gets paths excluded from monitoring.

getJobUserName

public String getJobUserName()

Gets the user ID for the connection.

getJobPasswd

public String getJobPasswd()

Gets the password for the connection.

getJobServer

public String getJobServer()

Gets the server name for the connection.

getJobDatabase

public String getJobDatabase()

Gets the database name for the connection.

getJobTimeZone

public String getJobTimeZone()

Gets the time zone for the connection.

getJobWebUrl

public String getJobWebUrl()

Gets the web URL for the connection.

isCanJobExpand

public boolean isCanJobExpand()

Gets the expand flag.

isCanJobNoMetadata

public boolean isCanJobNoMetadata()

Gets the no metadata flag.

isCanJobNoTouch

public boolean isCanJobNoTouch()

Gets the no touch flag.

isCanJobUpdate

public boolean isCanJobUpdate()

Gets the update flag.

isCanJobDelete

public boolean isCanJobDelete()

Gets the delete flag.

isCanJobForce

public boolean isCanJobForce()

Gets the force flag.

isCanJobRevert

public boolean isCanJobRevert()

Gets the revert flag.

isForceAsSlave

public boolean isForceAsSlave()

Gets force as slave flag.

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Does this SCM plugin require a workspace for polling?

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

supportsPolling

public boolean supportsPolling()

Does this SCM plugin support polling?

Overrides:

supportsPolling in class hudson.scm.SCM

buildEnvVars

public void buildEnvVars(hudson.model.AbstractBuild<?,?> build,
                Map<String,String> env)

Build up environment variables for build support.

Overrides:

buildEnvVars in class hudson.scm.SCM

checkout

public boolean checkout(hudson.model.AbstractBuild build,
               hudson.Launcher launcher,
               hudson.FilePath workspace,
               hudson.model.BuildListener listener,
               File changelogFile)
                 throws IOException,
                        InterruptedException

Checkout method for the plugin.

Specified by:

checkout in class hudson.scm.SCM

Throws:

IOException

InterruptedException

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(hudson.model.AbstractBuild<?,?> build,
                                                 hudson.Launcher launcher,
                                                 hudson.model.TaskListener listener)
                                                   throws IOException,
                                                          InterruptedException

Has the repository had any changes since last build?

Specified by:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

IOException

InterruptedException

compareRemoteRevisionWith

protected hudson.scm.PollingResult compareRemoteRevisionWith(hudson.model.AbstractProject<?,?> project,
                                                 hudson.Launcher launcher,
                                                 hudson.FilePath workspace,
                                                 hudson.model.TaskListener listener,
                                                 hudson.scm.SCMRevisionState baseline)
                                                      throws IOException,
                                                             InterruptedException

Has the repository had any changes?

Specified by:

compareRemoteRevisionWith in class hudson.scm.SCM

Throws:

IOException

InterruptedException

processWorkspaceBeforeDeletion

public boolean processWorkspaceBeforeDeletion(hudson.model.AbstractProject<?,?> project,
                                     hudson.FilePath workspace,
                                     hudson.model.Node node)
                                       throws IOException,
                                              InterruptedException

Okay to clear the area?

Overrides:

processWorkspaceBeforeDeletion in class hudson.scm.SCM

Throws:

IOException

InterruptedException

createPathMatcher

public PathMatcher createPathMatcher()

Creates path matcher to ignore changes on certain paths.

Returns:

path matcher

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Create a log parser object.

Specified by:

createChangeLogParser in class hudson.scm.SCM

getDescriptor

public DimensionsSCM.DescriptorImpl getDescriptor()

Return an SCM descriptor.

Specified by:

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

Overrides:

getDescriptor in class hudson.scm.SCM