org.apache.tools.ant.taskdefs.optional.vss
public abstract class MSVSS extends Task implements MSVSSConstants
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 Summary | |
---|---|
static class | MSVSS.CurrentModUpdated
Extention of EnumeratedAttribute to hold the values for file time stamp. |
static class | MSVSS.WritableFiles
Extention of EnumeratedAttribute to hold the values for writable filess. |
Method Summary | |
---|---|
void | execute()
Executes the task. |
protected String | getAutoresponse()
Gets the auto response string. |
protected String | getComment()
Gets the comment string. |
String | getFileTimeStamp()
Gets 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
|
protected String | getGetLocalCopy()
Builds and returns the -G- flag if required. |
protected String | getLabel()
Gets the label string. |
protected String | getLocalpath()
Gets the localpath string. |
protected String | getLogin()
Gets the login string. |
protected String | getOutput()
Gets the output file string. |
protected String | getQuiet()
Gets the quiet string. |
protected String | getRecursive()
Gets the recursive string. |
protected String | getSSCommand()
Gets the sscommand string. |
protected String | getStyle()
Gets the style string. |
protected String | getUser()
Gets the user string. |
protected String | getVersion()
Gets the version string. |
protected String | getVersionDate()
Gets the Version date string. |
protected String | getVersionDateLabel()
Gets the version string. |
protected String | getVersionLabel()
Gets the version string. |
protected String | getVsspath()
Gets the vssserverpath string. |
protected String | getWritable()
Gets the writable string. |
String | getWritableFiles()
Gets the value to determine the behaviour when encountering writable files. |
void | setFailOnError(boolean failOnError)
Indicates if the build should fail if the Sourcesafe command does. |
protected void | setInternalAutoResponse(String autoResponse)
Set the auto response attribute. |
protected void | setInternalComment(String comment)
Set the internal comment attribute. |
protected void | setInternalDate(String date)
Set the date attribute. |
protected void | setInternalDateFormat(DateFormat dateFormat)
Set the date format attribute. |
protected void | setInternalFailOnError(boolean failOnError)
Set the failOnError attribute. |
protected void | setInternalFileTimeStamp(MSVSS.CurrentModUpdated timestamp)
Set the timestamp attribute. |
protected void | setInternalFromDate(String fromDate)
Set the from date attribute. |
protected void | setInternalFromLabel(String fromLabel)
Set the from label attribute. |
protected void | setInternalGetLocalCopy(boolean getLocalCopy)
Set the getLocalCopy attribute. |
protected void | setInternalLabel(String label)
Set the label attribute. |
protected void | setInternalLocalPath(String localPath)
Set the local path comment attribute. |
protected void | setInternalNumDays(int numDays)
Set the num days attribute. |
protected void | setInternalOutputFilename(String outputFileName)
Set the outputFileName comment attribute. |
protected void | setInternalQuiet(boolean quiet)
Set the quiet attribute. |
protected void | setInternalRecursive(boolean recursive)
Set the recursive attribute. |
protected void | setInternalStyle(String style)
Set the style attribute. |
protected void | setInternalToDate(String toDate)
Set the to date attribute. |
protected void | setInternalToLabel(String toLabel)
Set the to label attribute. |
protected void | setInternalUser(String user)
Set the user attribute. |
protected void | setInternalVersion(String version)
Set the version attribute. |
protected void | setInternalWritable(boolean writable)
Set the writable attribute. |
protected void | setInternalWritableFiles(MSVSS.WritableFiles writableFiles)
Set the writableFiles attribute. |
void | setLogin(String vssLogin)
Login to use when accessing VSS, formatted as "username,password".
|
void | setServerpath(String serverPath)
Directory where srssafe.ini resides. |
void | setSsdir(String dir)
Directory where ss.exe resides.
|
void | setVsspath(String vssPath)
SourceSafe path which specifies the project/file(s) you wish to perform
the action on.
|
Throws: BuildException if the command cannot execute.
Returns: The default value "-I-" if autoresponse is not set.
Returns: A comment of "-" if comment is not set.
Returns: The default file time flag, if not set.
Returns: An empty string if get local copy is true.
Returns: An empty string if label is not set.
The localpath is created if it didn't exist.
Returns: An empty string if localpath is not set.
Returns: An empty string if login is not set.
Returns: An empty string if user is not set.
Returns: An empty string if quiet is not set or is false.
Returns: An empty string if recursive is not set or is false.
Returns: The path to ss.exe or just ss if sscommand is not set.
Returns: An empty string if label is not set.
Returns: An empty string if user is not set.
Returns: An empty string if a version is not set.
Returns: An empty string if neither Todate or from date are set.
Throws: BuildException if there is an error.
Returns: An empty string if a version, date and label are not set.
Returns: An empty string if neither tolabel or fromlabel are set.
Returns: null if vssserverpath is not set.
Returns: An empty string if writable is not set or is false.
Returns: An empty String, if not set.
Parameters: failOnError True if task should fail on any error.
Parameters: autoResponse the value to use.
Parameters: comment the value to use.
Parameters: date the value to use.
Parameters: dateFormat the value to use.
Parameters: failOnError the value to use.
Parameters: timestamp the value to use.
Parameters: fromDate the value to use.
Parameters: fromLabel the value to use.
Parameters: getLocalCopy the value to use.
Parameters: label the value to use.
Parameters: localPath the value to use.
Parameters: numDays the value to use.
Parameters: outputFileName the value to use.
Parameters: quiet the value to use.
Parameters: recursive the value to use.
Parameters: style the value to use.
Parameters: toDate the value to use.
Parameters: toLabel the value to use.
Parameters: user the value to use.
Parameters: version the value to use.
Parameters: writable the value to use.
Parameters: writableFiles the value to use.
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.
srssafe.ini
resides.Parameters: serverPath The path to the VSS server.
ss.exe
resides.
By default the task expects it to be in the PATH.Parameters: dir The directory containing ss.exe.
A prefix of 'vss://' will be removed if specified.
Parameters: vssPath The VSS project path.
UNKNOWN: group="required"