|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tools.ant.ProjectComponent org.apache.tools.ant.Task org.apache.tools.ant.taskdefs.optional.sos.SOS
public abstract class SOS
A base class for creating tasks for executing commands on SourceOffSite. These tasks were inspired by the VSS tasks.
Field Summary | |
---|---|
protected Commandline |
commandLine
Commandline to be executed. |
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd |
---|
COMMAND_CHECKIN_FILE, COMMAND_CHECKIN_PROJECT, COMMAND_CHECKOUT_FILE, COMMAND_CHECKOUT_PROJECT, COMMAND_GET_FILE, COMMAND_GET_PROJECT, COMMAND_HISTORY, COMMAND_LABEL, COMMAND_SOS_EXE, FLAG_COMMAND, FLAG_COMMENT, FLAG_FILE, FLAG_LABEL, FLAG_NO_CACHE, FLAG_NO_COMPRESSION, FLAG_PASSWORD, FLAG_PROJECT, FLAG_RECURSION, FLAG_SOS_HOME, FLAG_SOS_SERVER, FLAG_USERNAME, FLAG_VERBOSE, FLAG_VERSION, FLAG_VSS_SERVER, FLAG_WORKING_DIR, PROJECT_PREFIX |
Constructor Summary | |
---|---|
SOS()
|
Method Summary | |
---|---|
void |
execute()
Execute the created command line. |
protected java.lang.String |
getComment()
Get the comment |
protected java.lang.String |
getFilename()
Get the filename to be acted upon. |
protected java.lang.String |
getLabel()
Get the label |
protected java.lang.String |
getLocalPath()
Builds and returns the working directory. |
protected java.lang.String |
getNoCache()
Get the NoCache flag. |
protected java.lang.String |
getNoCompress()
Get the NoCompress flag. |
protected void |
getOptionalAttributes()
Adds the optional attributes to the command line. |
protected java.lang.String |
getPassword()
Get the password |
protected java.lang.String |
getProjectPath()
Get the project path |
protected java.lang.String |
getRecursive()
Get the 'recursive' Flag. |
protected void |
getRequiredAttributes()
Sets the executable and add the required attributes to the command line. |
protected java.lang.String |
getSosCommand()
Get the executable to run. |
protected java.lang.String |
getSosHome()
Get the SOS home directory. |
protected java.lang.String |
getSosServerPath()
Get the SOS serve path. |
protected java.lang.String |
getUsername()
Get the username |
protected java.lang.String |
getVerbose()
Get the 'verbose' Flag. |
protected java.lang.String |
getVersion()
Get the version |
protected java.lang.String |
getVssServerPath()
Get the VSS server path |
protected int |
run(Commandline cmd)
Execute the created command line. |
protected void |
setInternalComment(java.lang.String text)
Set the comment text. |
protected void |
setInternalFilename(java.lang.String file)
Set the file name. |
protected void |
setInternalLabel(java.lang.String text)
Set the label. |
protected void |
setInternalRecursive(boolean recurse)
Set the recursive flag. |
protected void |
setInternalVersion(java.lang.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(java.lang.String password)
The SourceSafe password. |
void |
setProjectPath(java.lang.String projectpath)
The SourceSafe project path. |
void |
setSosCmd(java.lang.String dir)
The directory where soscmd(.exe) is located. |
void |
setSosHome(java.lang.String sosHome)
Path to the SourceOffSite home directory. |
void |
setSosServerPath(java.lang.String sosServerPath)
The address and port of SourceOffSite Server, for example 192.168.0.1:8888. |
void |
setUsername(java.lang.String username)
The SourceSafe username. |
void |
setVerbose(boolean verbose)
Enable verbose output. |
void |
setVssServerPath(java.lang.String vssServerPath)
The path to the location of the ss.ini file. |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Commandline commandLine
Constructor Detail |
---|
public SOS()
Method Detail |
---|
public final void setNoCache(boolean nocache)
nocache
- True to disable caching.public final void setNoCompress(boolean nocompress)
nocompress
- True to disable compression.public final void setSosCmd(java.lang.String dir)
dir
- The new sosCmd value.public final void setUsername(java.lang.String username)
username
- The new username value.public final void setPassword(java.lang.String password)
password
- The new password value.public final void setProjectPath(java.lang.String projectpath)
projectpath
- The new projectpath value.public final void setVssServerPath(java.lang.String vssServerPath)
vssServerPath
- The new vssServerPath value.public final void setSosHome(java.lang.String sosHome)
sosHome
- The new sosHome value.public final void setSosServerPath(java.lang.String sosServerPath)
sosServerPath
- The new sosServerPath value.public final void setLocalPath(Path path)
path
- The new localPath value.public void setVerbose(boolean verbose)
verbose
- True for verbose output.protected void setInternalFilename(java.lang.String file)
file
- the filename to use.protected void setInternalRecursive(boolean recurse)
recurse
- if true use the recursive flag on the command line.protected void setInternalComment(java.lang.String text)
text
- the comment text to use.protected void setInternalLabel(java.lang.String text)
text
- the label to use.protected void setInternalVersion(java.lang.String text)
text
- the version to use.protected java.lang.String getSosCommand()
protected java.lang.String getComment()
protected java.lang.String getVersion()
protected java.lang.String getLabel()
protected java.lang.String getUsername()
protected java.lang.String getPassword()
protected java.lang.String getProjectPath()
protected java.lang.String getVssServerPath()
protected java.lang.String getSosHome()
protected java.lang.String getSosServerPath()
protected java.lang.String getFilename()
protected java.lang.String getNoCompress()
protected java.lang.String getNoCache()
protected java.lang.String getVerbose()
protected java.lang.String getRecursive()
protected java.lang.String getLocalPath()
The localpath is created if it didn't exist.
public void execute() throws BuildException
execute
in class Task
BuildException
- on error.protected int run(Commandline cmd)
cmd
- The command line to run.
BuildException
protected void getRequiredAttributes()
protected void getOptionalAttributes()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |