scm.vss
Class VSSSCM

java.lang.Object
  hudson.scm.SCM
      scm.vss.VSSSCM

All Implemented Interfaces:

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

public class VSSSCM
extends hudson.scm.SCM

Manages the content from Microsoft Visual Source Safe.

Author:

vara

Nested Class Summary

static class

VSSSCM.VSSDescriptor VSS descriptor that describes about the VSS SCM.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

VSSSCM(java.lang.String serverPath, java.lang.String user, java.lang.String password, java.lang.String vssPath, boolean isWritable, boolean isRecursive, boolean useUpdate)
All the details necessary to get the content from VSS.

Method Summary

boolean	checkout(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.BuildListener listener, java.io.File changelogFile) Fetches the content from VSS.
hudson.scm.ChangeLogParser	createChangeLogParser() Returns the change log parser.
static java.lang.String	escapeForXml(java.lang.Object object) Converts the input in the way that it can be written to the XML.
hudson.FilePath	getModuleRoot(hudson.FilePath workspace) Module root same as the workspace root.
java.lang.String	getPassword()
java.lang.String	getServerPath()
java.lang.String	getUser()
java.lang.String	getVssPath()
boolean	isRecursive()
boolean	isUseUpdate()
boolean	isWritable()
boolean	pollChanges(hudson.model.AbstractProject project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener) Poll for changes in the workspace in VSS.

Methods inherited from class hudson.scm.SCM

_for, all, buildEnvVars, createEmptyChangeLog, getBrowser, getDescriptor, getEffectiveBrowser, getModuleRoots, nullify, processWorkspaceBeforeDeletion, requiresWorkspaceForPolling, supportsPolling

Methods inherited from class java.lang.Object

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

Constructor Detail

VSSSCM

public VSSSCM(java.lang.String serverPath,
              java.lang.String user,
              java.lang.String password,
              java.lang.String vssPath,
              boolean isWritable,
              boolean isRecursive,
              boolean useUpdate)

All the details necessary to get the content from VSS.

Parameters:

serverPath - Path to srcsafe.ini file.

user - User name.

password - Password.

vssPath - Directory path in the VSS server.

isWritable - Indicates whether to keep the files in wriable mode or not.

isRecursive - Indicates whether to get the files in recursive order or not.

Method Detail

getModuleRoot

public hudson.FilePath getModuleRoot(hudson.FilePath workspace)

Module root same as the workspace root.

Overrides:

getModuleRoot in class hudson.scm.SCM

pollChanges

public boolean pollChanges(hudson.model.AbstractProject project,
                           hudson.Launcher launcher,
                           hudson.FilePath workspace,
                           hudson.model.TaskListener listener)
                    throws java.io.IOException

Poll for changes in the workspace in VSS.

Specified by:

pollChanges in class hudson.scm.SCM

Throws:

java.io.IOException

checkout

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

Fetches the content from VSS.

Specified by:

checkout in class hudson.scm.SCM

Throws:

java.io.IOException

java.lang.InterruptedException

escapeForXml

public static java.lang.String escapeForXml(java.lang.Object object)

Converts the input in the way that it can be written to the XML. Special characters are converted to XML understandable way.

Parameters:

object - The object to be escaped.

Returns:

Escaped string that can be written to XML.

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Returns the change log parser.

Specified by:

createChangeLogParser in class hudson.scm.SCM

isWritable

public boolean isWritable()

Returns:

The writable flag.

isRecursive

public boolean isRecursive()

Returns:

The recursive flag.

isUseUpdate

public boolean isUseUpdate()

Returns:

The useUpdate flag.

getPassword

public java.lang.String getPassword()

Returns:

The password.

getServerPath

public java.lang.String getServerPath()

Returns:

VSS srcsafe.ini path.

getUser

public java.lang.String getUser()

Returns:

The user name.

getVssPath

public java.lang.String getVssPath()

Returns:

The VSS path.