org.apache.tools.ant.taskdefs.optional.sos
public abstract class SOS extends Task implements SOSCmd
Field Summary | |
---|---|
protected Commandline | commandLine Commandline to be executed. |
Method Summary | |
---|---|
void | execute()
Execute the created command line.
|
protected String | getComment()
Get the comment |
protected String | getFilename()
Get the filename to be acted upon. |
protected String | getLabel()
Get the label |
protected String | getLocalPath()
Builds and returns the working directory.
|
protected String | getNoCache()
Get the NoCache flag.
|
protected String | getNoCompress()
Get the NoCompress flag.
|
protected void | getOptionalAttributes() Adds the optional attributes to the command line. |
protected String | getPassword()
Get the password |
protected String | getProjectPath()
Get the project path |
protected String | getRecursive()
Get the 'recursive' Flag.
|
protected void | getRequiredAttributes() Sets the executable and add the required attributes to the command line. |
protected String | getSosCommand()
Get the executable to run. |
protected String | getSosHome()
Get the SOS home directory. |
protected String | getSosServerPath()
Get the SOS serve path. |
protected String | getUsername()
Get the username |
protected String | getVerbose()
Get the 'verbose' Flag.
|
protected String | getVersion()
Get the version |
protected String | getVssServerPath()
Get the VSS server path |
protected int | run(Commandline cmd)
Execute the created command line.
|
protected void | setInternalComment(String text)
Set the comment text. |
protected void | setInternalFilename(String file)
Set the file name. |
protected void | setInternalLabel(String text)
Set the label. |
protected void | setInternalRecursive(boolean recurse)
Set the recursive flag. |
protected void | setInternalVersion(String text)
Set the version. |
void | setLocalPath(Path path)
Override the working directory and get to the specified path.
|
void | setNoCache(boolean nocache)
Flag to disable the cache when set.
|
void | setNoCompress(boolean nocompress)
Flag to disable compression when set. |
void | setPassword(String password)
The SourceSafe password.
|
void | setProjectPath(String projectpath)
The SourceSafe project path.
|
void | setSosCmd(String dir)
The directory where soscmd(.exe) is located.
soscmd must be on the path if omitted.
|
void | setSosHome(String sosHome)
Path to the SourceOffSite home directory.
|
void | setSosServerPath(String sosServerPath)
The address and port of SourceOffSite Server,
for example 192.168.0.1:8888.
|
void | setUsername(String username)
The SourceSafe username.
|
void | setVerbose(boolean verbose)
Enable verbose output. |
void | setVssServerPath(String vssServerPath)
The path to the location of the ss.ini file.
|
Throws: BuildException on error.
Returns: if it was set, null if not.
Returns: if it was set, null if not.
Returns: if it was set, null if not.
The localpath is created if it didn't exist.
Returns: the absolute path of the working directory.
Returns: the 'nocache' Flag if the attribute was 'true', otherwise an empty string.
Returns: the 'nocompress' Flag if the attribute was 'true', otherwise an empty string.
Returns: empty string if it wasn't set.
Returns: if it was set, null if not.
Returns: the 'recursive' Flag if the attribute was 'true', otherwise an empty string.
Returns: the executable to run.
Returns: if it was set, null if not.
Returns: if it was set, null if not.
Returns: if it was set, null if not.
Returns: the 'verbose' Flag if the attribute was 'true', otherwise an empty string.
Returns: if it was set, null if not.
Returns: if it was set, null if not.
Parameters: cmd The command line to run.
Returns: int the exit code.
Throws: BuildException
Parameters: text the comment text to use.
Parameters: file the filename to use.
Parameters: text the label to use.
Parameters: recurse if true use the recursive flag on the command line.
Parameters: text the version to use.
Parameters: path The new localPath value.
Parameters: nocache True to disable caching.
Parameters: nocompress True to disable compression.
Parameters: password The new password value.
Parameters: projectpath The new projectpath value.
UNKNOWN: group="required"
Parameters: dir The new sosCmd value.
Parameters: sosHome The new sosHome value.
Parameters: sosServerPath The new sosServerPath value.
UNKNOWN: group="required"
Parameters: username The new username value.
UNKNOWN: group="required"
Parameters: verbose True for verbose output.
Parameters: vssServerPath The new vssServerPath value.
UNKNOWN: group="required"