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) |
protected void | setInternalComment(String comment) |
protected void | setInternalDate(String date) |
protected void | setInternalDateFormat(DateFormat dateFormat) |
protected void | setInternalFailOnError(boolean failOnError) |
protected void | setInternalFileTimeStamp(MSVSS.CurrentModUpdated timestamp) |
protected void | setInternalFromDate(String fromDate) |
protected void | setInternalFromLabel(String fromLabel) |
protected void | setInternalGetLocalCopy(boolean getLocalCopy) |
protected void | setInternalLabel(String label) |
protected void | setInternalLocalPath(String localPath) |
protected void | setInternalNumDays(int numDays) |
protected void | setInternalOutputFilename(String outputFileName) |
protected void | setInternalQuiet(boolean quiet) |
protected void | setInternalRecursive(boolean recursive) |
protected void | setInternalStyle(String style) |
protected void | setInternalToDate(String toDate) |
protected void | setInternalToLabel(String toLabel) |
protected void | setInternalUser(String user) |
protected void | setInternalVersion(String version) |
protected void | setInternalWritable(boolean writable) |
protected void | setInternalWritableFiles(MSVSS.WritableFiles writableFiles) |
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
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.
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"