Class MSVSS
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.vss.MSVSS
- All Implemented Interfaces:
- Cloneable,- MSVSSConstants
- Direct Known Subclasses:
- MSVSSADD,- MSVSSCHECKIN,- MSVSSCHECKOUT,- MSVSSCP,- MSVSSCREATE,- MSVSSGET,- MSVSSHISTORY,- MSVSSLABEL
A base class for creating tasks for executing commands on Visual SourceSafe.
 
The class extends the 'exec' task as it operates by executing the ss.exe program supplied with SourceSafe. By default the task expects ss.exe to be in the path, you can override this be specifying the ssdir attribute.
This class provides set and get methods for 'login' and 'vsspath' attributes. It also contains constants for the flags that can be passed to SS.
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classExtension of EnumeratedAttribute to hold the values for file time stamp.static classExtension of EnumeratedAttribute to hold the values for writable filess.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, projectFields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstantsCOMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidexecute()Executes the task.protected StringGets the auto response string.protected StringGets the comment string.Gets the value set for the FileTimeStamp.protected StringBuilds and returns the -G- flag if required.protected StringgetLabel()Gets the label string.protected StringGets the localpath string.protected StringgetLogin()Gets the login string.protected StringGets the output file string.protected StringgetQuiet()Gets the quiet string.protected StringGets the recursive string.protected StringGets the sscommand string.protected StringgetStyle()Gets the style string.protected StringgetUser()Gets the user string.protected StringGets the version string.protected StringGets the Version date string.protected StringGets the version string.protected StringGets the version string.protected StringGets the vssserverpath string.protected StringGets the writable string.Gets the value to determine the behaviour when encountering writable files.final voidsetFailOnError(boolean failOnError) Indicates if the build should fail if the Sourcesafe command does.protected voidsetInternalAutoResponse(String autoResponse) Set the auto response attribute.protected voidsetInternalComment(String comment) Set the internal comment attribute.protected voidsetInternalDate(String date) Set the date attribute.protected voidsetInternalDateFormat(DateFormat dateFormat) Set the date format attribute.protected voidsetInternalFailOnError(boolean failOnError) Set the failOnError attribute.protected voidsetInternalFileTimeStamp(MSVSS.CurrentModUpdated timestamp) Set the timestamp attribute.protected voidsetInternalFromDate(String fromDate) Set the from date attribute.protected voidsetInternalFromLabel(String fromLabel) Set the from label attribute.protected voidsetInternalGetLocalCopy(boolean getLocalCopy) Set the getLocalCopy attribute.protected voidsetInternalLabel(String label) Set the label attribute.protected voidsetInternalLocalPath(String localPath) Set the local path comment attribute.protected voidsetInternalNumDays(int numDays) Set the num days attribute.protected voidsetInternalOutputFilename(String outputFileName) Set the outputFileName comment attribute.protected voidsetInternalQuiet(boolean quiet) Set the quiet attribute.protected voidsetInternalRecursive(boolean recursive) Set the recursive attribute.protected voidsetInternalStyle(String style) Set the style attribute.protected voidsetInternalToDate(String toDate) Set the to date attribute.protected voidsetInternalToLabel(String toLabel) Set the to label attribute.protected voidsetInternalUser(String user) Set the user attribute.protected voidsetInternalVersion(String version) Set the version attribute.protected voidsetInternalWritable(boolean writable) Set the writable attribute.protected voidsetInternalWritableFiles(MSVSS.WritableFiles writableFiles) Set the writableFiles attribute.final voidLogin to use when accessing VSS, formatted as "username,password".final voidsetServerpath(String serverPath) Directory wheresrssafe.iniresides.final voidDirectory wheress.exeresides.final voidsetVsspath(String vssPath) SourceSafe path which specifies the project/file(s) you wish to perform the action on.Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
MSVSSpublic MSVSS()
 
- 
- 
Method Details- 
setSsdirDirectory wheress.exeresides. By default the task expects it to be in the PATH.- Parameters:
- dir- The directory containing ss.exe.
 
- 
setLoginLogin to use when accessing VSS, formatted as "username,password".You can omit the password if your database is not password protected. If you have a password and omit it, Ant will hang. - Parameters:
- vssLogin- The login string to use.
 
- 
setVsspathSourceSafe path which specifies the project/file(s) you wish to perform the action on.A prefix of 'vss://' will be removed if specified. - Parameters:
- vssPath- The VSS project path.
 
- 
setServerpathDirectory wheresrssafe.iniresides.- Parameters:
- serverPath- The path to the VSS server.
 
- 
setFailOnErrorpublic final void setFailOnError(boolean failOnError) Indicates if the build should fail if the Sourcesafe command does. Defaults to true.- Parameters:
- failOnError- True if task should fail on any error.
 
- 
executeExecutes the task.Builds a command line to execute ss.exe and then calls Exec's run method to execute the command line. - Overrides:
- executein class- Task
- Throws:
- BuildException- if the command cannot execute.
 
- 
setInternalCommentSet the internal comment attribute.- Parameters:
- comment- the value to use.
 
- 
setInternalAutoResponseSet the auto response attribute.- Parameters:
- autoResponse- the value to use.
 
- 
setInternalDateSet the date attribute.- Parameters:
- date- the value to use.
 
- 
setInternalDateFormatSet the date format attribute.- Parameters:
- dateFormat- the value to use.
 
- 
setInternalFailOnErrorprotected void setInternalFailOnError(boolean failOnError) Set the failOnError attribute.- Parameters:
- failOnError- the value to use.
 
- 
setInternalFromDateSet the from date attribute.- Parameters:
- fromDate- the value to use.
 
- 
setInternalFromLabelSet the from label attribute.- Parameters:
- fromLabel- the value to use.
 
- 
setInternalLabelSet the label attribute.- Parameters:
- label- the value to use.
 
- 
setInternalLocalPathSet the local path comment attribute.- Parameters:
- localPath- the value to use.
 
- 
setInternalNumDaysprotected void setInternalNumDays(int numDays) Set the num days attribute.- Parameters:
- numDays- the value to use.
 
- 
setInternalOutputFilenameSet the outputFileName comment attribute.- Parameters:
- outputFileName- the value to use.
 
- 
setInternalQuietprotected void setInternalQuiet(boolean quiet) Set the quiet attribute.- Parameters:
- quiet- the value to use.
 
- 
setInternalRecursiveprotected void setInternalRecursive(boolean recursive) Set the recursive attribute.- Parameters:
- recursive- the value to use.
 
- 
setInternalStyleSet the style attribute.- Parameters:
- style- the value to use.
 
- 
setInternalToDateSet the to date attribute.- Parameters:
- toDate- the value to use.
 
- 
setInternalToLabelSet the to label attribute.- Parameters:
- toLabel- the value to use.
 
- 
setInternalUserSet the user attribute.- Parameters:
- user- the value to use.
 
- 
setInternalVersionSet the version attribute.- Parameters:
- version- the value to use.
 
- 
setInternalWritableprotected void setInternalWritable(boolean writable) Set the writable attribute.- Parameters:
- writable- the value to use.
 
- 
setInternalFileTimeStampSet the timestamp attribute.- Parameters:
- timestamp- the value to use.
 
- 
setInternalWritableFilesSet the writableFiles attribute.- Parameters:
- writableFiles- the value to use.
 
- 
setInternalGetLocalCopyprotected void setInternalGetLocalCopy(boolean getLocalCopy) Set the getLocalCopy attribute.- Parameters:
- getLocalCopy- the value to use.
 
- 
getSSCommandGets the sscommand string. "ss" or "c:\path\to\ss"- Returns:
- The path to ss.exe or just ss if sscommand is not set.
 
- 
getVsspathGets the vssserverpath string.- Returns:
- null if vssserverpath is not set.
 
- 
getQuietGets the quiet string. -O-- Returns:
- An empty string if quiet is not set or is false.
 
- 
getRecursiveGets the recursive string. "-R"- Returns:
- An empty string if recursive is not set or is false.
 
- 
getWritableGets the writable string. "-W"- Returns:
- An empty string if writable is not set or is false.
 
- 
getLabelGets the label string. "-Lbuild1" Max label length is 32 chars- Returns:
- An empty string if label is not set.
 
- 
getStyleGets the style string. "-Lbuild1"- Returns:
- An empty string if label is not set.
 
- 
getVersionDateLabelGets the version string. Returns the first specified of version "-V1.0", date "-Vd01.01.01", label "-Vlbuild1".- Returns:
- An empty string if a version, date and label are not set.
 
- 
getVersionGets the version string.- Returns:
- An empty string if a version is not set.
 
- 
getLocalpathGets the localpath string. "-GLc:\source"The localpath is created if it didn't exist. - Returns:
- An empty string if localpath is not set.
 
- 
getCommentGets the comment string. "-Ccomment text"- Returns:
- A comment of "-" if comment is not set.
 
- 
getAutoresponseGets the auto response string. This can be Y "-I-Y" or N "-I-N".- Returns:
- The default value "-I-" if autoresponse is not set.
 
- 
getLoginGets the login string. This can be user and password, "-Yuser,password" or just user "-Yuser".- Returns:
- An empty string if login is not set.
 
- 
getOutputGets the output file string. "-Ooutput.file"- Returns:
- An empty string if user is not set.
 
- 
getUserGets the user string. "-Uusername"- Returns:
- An empty string if user is not set.
 
- 
getVersionLabelGets the version string. This can be to-from "-VLbuild2~Lbuild1", from "~Lbuild1" or to "-VLbuild2".- Returns:
- An empty string if neither tolabel or fromlabel are set.
 
- 
getVersionDateGets the Version date string.- Returns:
- An empty string if neither Todate or from date are set.
- Throws:
- BuildException- if there is an error.
 
- 
getGetLocalCopyBuilds and returns the -G- flag if required.- Returns:
- An empty string if get local copy is true.
 
- 
getFileTimeStampGets the value set for the FileTimeStamp. if it equals "current" then we return -GTC if it equals "modified" then we return -GTM if it equals "updated" then we return -GTU otherwise we return -GTC- Returns:
- The default file time flag, if not set.
 
- 
getWritableFilesGets the value to determine the behaviour when encountering writable files.- Returns:
- An empty String, if not set.
 
 
-