java.lang.Cloneable, LogListenerpublic class SSHExec extends SSHBase
description, location, project| Constructor | Description |
|---|---|
SSHExec() |
Constructor for SSHExecTask.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
execute() |
Execute the command on the remote host.
|
void |
setAppend(boolean append) |
Determines if the output is appended to the file given in
setOutput. |
void |
setCommand(java.lang.String command) |
Sets the command to execute on the remote host.
|
void |
setCommandResource(java.lang.String f) |
Sets a commandResource from a file
|
void |
setErrAppend(boolean appenderr) |
Determines if the output is appended to the file given in
setErrorOutput. |
void |
setErrorOutput(java.io.File output) |
If used, stores the erroutput of the command to the given file.
|
void |
setErrorproperty(java.lang.String property) |
If set, the erroroutput of the command will be stored in the given property.
|
void |
setInput(java.io.File input) |
If used, the content of the file is piped to the remote command
|
void |
setInputProperty(java.lang.String inputProperty) |
If used, the content of the property is piped to the remote command
|
void |
setInputString(java.lang.String inputString) |
If used, the string is piped to the remote command.
|
void |
setOutput(java.io.File output) |
If used, stores the output of the command to the given file.
|
void |
setOutputproperty(java.lang.String property) |
If set, the output of the command will be stored in the given property.
|
void |
setResultproperty(java.lang.String property) |
If set, the exitcode of the command will be stored in the given property.
|
void |
setSuppressSystemErr(boolean suppressSystemErr) |
If suppressSystemErr is
true, output will not be sent to System.err,
if suppressSystemErr is false, normal behavior |
void |
setSuppressSystemOut(boolean suppressSystemOut) |
If suppressSystemOut is
true, output will not be sent to System.out,
if suppressSystemOut is false, normal behavior |
void |
setTimeout(long timeout) |
The connection can be dropped after a specified number of
milliseconds.
|
void |
setUsePty(boolean b) |
Whether a pseudo-tty should be allocated.
|
void |
setUseSystemIn(boolean useSystemIn) |
If set, input will be taken from System.in
|
logequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getDescription, getLocation, getProject, setDescription, setLocation, setProjectgetFailonerror, getHost, getPort, getServerAliveCountMax, getServerAliveIntervalSeconds, getUserInfo, getVerbose, init, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setServerAliveCountMax, setServerAliveIntervalSeconds, setTrust, setUsername, setVerbosebindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypepublic void setCommand(java.lang.String command)
command - The new command valuepublic void setCommandResource(java.lang.String f)
f - the value to use.public void setTimeout(long timeout)
timeout - The new timeout value in secondspublic void setOutput(java.io.File output)
output - The file to write to.public void setErrorOutput(java.io.File output)
output - The file to write to.public void setInput(java.io.File input)
input - The file which provides the input data for the remote commandpublic void setInputProperty(java.lang.String inputProperty)
inputProperty - The property which contains the input data
for the remote command.public void setInputString(java.lang.String inputString)
inputString - the input data for the remote command.public void setAppend(boolean append)
setOutput. Default is false, that is, overwrite
the file.append - True to append to an existing file, false to overwrite.public void setErrAppend(boolean appenderr)
setErrorOutput. Default is false, that is, overwrite
the file.appenderr - True to append to an existing file, false to overwrite.public void setOutputproperty(java.lang.String property)
property - The name of the property in which the command output
will be stored.public void setErrorproperty(java.lang.String property)
property - The name of the property in which the command erroroutput
will be stored.public void setResultproperty(java.lang.String property)
property - The name of the property in which the exitcode
will be stored.public void setUsePty(boolean b)
b - booleanpublic void setUseSystemIn(boolean useSystemIn)
useSystemIn - True to use System.in as InputStream, false otherwisepublic void setSuppressSystemOut(boolean suppressSystemOut)
true, output will not be sent to System.out,
if suppressSystemOut is false, normal behaviorsuppressSystemOut - booleanpublic void setSuppressSystemErr(boolean suppressSystemErr)
true, output will not be sent to System.err,
if suppressSystemErr is false, normal behaviorsuppressSystemErr - booleanpublic void execute()
throws BuildException
execute in class TaskBuildException - Most likely a network error or bad parameter.