Class SSHExec
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
org.apache.tools.ant.taskdefs.optional.ssh.SSHExec
- All Implemented Interfaces:
- Cloneable,- LogListener
Executes a command on a remote machine via ssh.
- Since:
- Ant 1.6 (created February 2, 2003)
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidexecute()Execute the command on the remote host.voidsetAppend(boolean append) Determines if the output is appended to the file given insetOutput.voidsetCommand(String command) Sets the command to execute on the remote host.voidSets a commandResource from a filevoidsetErrAppend(boolean appenderr) Determines if the output is appended to the file given insetErrorOutput.voidsetErrorOutput(File output) If used, stores the erroutput of the command to the given file.voidsetErrorproperty(String property) If set, the erroroutput of the command will be stored in the given property.voidIf used, the content of the file is piped to the remote commandvoidsetInputProperty(String inputProperty) If used, the content of the property is piped to the remote commandvoidsetInputString(String inputString) If used, the string is piped to the remote command.voidIf used, stores the output of the command to the given file.voidsetOutputproperty(String property) If set, the output of the command will be stored in the given property.voidsetResultproperty(String property) If set, the exitcode of the command will be stored in the given property.voidsetSuppressSystemErr(boolean suppressSystemErr) If suppressSystemErr istrue, output will not be sent to System.err, if suppressSystemErr isfalse, normal behaviorvoidsetSuppressSystemOut(boolean suppressSystemOut) If suppressSystemOut istrue, output will not be sent to System.out, if suppressSystemOut isfalse, normal behaviorvoidsetTimeout(long timeout) The connection can be dropped after a specified number of milliseconds.voidsetUsePty(boolean b) Whether a pseudo-tty should be allocated.voidsetUseSystemIn(boolean useSystemIn) If set, input will be taken from System.inMethods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.SSHBaseaddConfiguredAdditionalConfig, getFailonerror, getHost, getPort, getServerAliveCountMax, getServerAliveIntervalSeconds, getSshConfig, getUserInfo, getVerbose, init, loadSshConfig, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setServerAliveCountMax, setServerAliveIntervalSeconds, setSshConfig, setTrust, setUsername, setVerboseMethods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListenerlog
- 
Constructor Details- 
SSHExecpublic SSHExec()Constructor for SSHExecTask.
 
- 
- 
Method Details- 
setCommandSets the command to execute on the remote host.- Parameters:
- command- The new command value
 
- 
setCommandResourceSets a commandResource from a file- Parameters:
- f- the value to use.
- Since:
- Ant 1.7.1
 
- 
setTimeoutpublic void setTimeout(long timeout) The connection can be dropped after a specified number of milliseconds. This is sometimes useful when a connection may be flaky. Default is 0, which means "wait forever".- Parameters:
- timeout- The new timeout value in seconds
 
- 
setOutputIf used, stores the output of the command to the given file.- Parameters:
- output- The file to write to.
 
- 
setErrorOutputIf used, stores the erroutput of the command to the given file.- Parameters:
- output- The file to write to.
- Since:
- Apache Ant 1.9.4
 
- 
setInputIf used, the content of the file is piped to the remote command- Parameters:
- input- The file which provides the input data for the remote command
- Since:
- Ant 1.8.0
 
- 
setInputPropertyIf used, the content of the property is piped to the remote command- Parameters:
- inputProperty- The property which contains the input data for the remote command.
- Since:
- Ant 1.8.0
 
- 
setInputStringIf used, the string is piped to the remote command.- Parameters:
- inputString- the input data for the remote command.
- Since:
- Ant 1.8.3
 
- 
setAppendpublic void setAppend(boolean append) Determines if the output is appended to the file given insetOutput. Default is false, that is, overwrite the file.- Parameters:
- append- True to append to an existing file, false to overwrite.
 
- 
setErrAppendpublic void setErrAppend(boolean appenderr) Determines if the output is appended to the file given insetErrorOutput. Default is false, that is, overwrite the file.- Parameters:
- appenderr- True to append to an existing file, false to overwrite.
- Since:
- Apache Ant 1.9.4
 
- 
setOutputpropertyIf set, the output of the command will be stored in the given property.- Parameters:
- property- The name of the property in which the command output will be stored.
 
- 
setErrorpropertyIf set, the erroroutput of the command will be stored in the given property.- Parameters:
- property- The name of the property in which the command erroroutput will be stored.
- Since:
- Apache Ant 1.9.4
 
- 
setResultpropertyIf set, the exitcode of the command will be stored in the given property.- Parameters:
- property- The name of the property in which the exitcode will be stored.
- Since:
- Apache Ant 1.9.4
 
- 
setUsePtypublic void setUsePty(boolean b) Whether a pseudo-tty should be allocated.- Parameters:
- b- boolean
- Since:
- Apache Ant 1.8.3
 
- 
setUseSystemInpublic void setUseSystemIn(boolean useSystemIn) If set, input will be taken from System.in- Parameters:
- useSystemIn- True to use System.in as InputStream, false otherwise
- Since:
- Apache Ant 1.9.4
 
- 
setSuppressSystemOutpublic void setSuppressSystemOut(boolean suppressSystemOut) If suppressSystemOut istrue, output will not be sent to System.out, if suppressSystemOut isfalse, normal behavior- Parameters:
- suppressSystemOut- boolean
- Since:
- Ant 1.9.0
 
- 
setSuppressSystemErrpublic void setSuppressSystemErr(boolean suppressSystemErr) If suppressSystemErr istrue, output will not be sent to System.err, if suppressSystemErr isfalse, normal behavior- Parameters:
- suppressSystemErr- boolean
- Since:
- Ant 1.9.4
 
- 
executeExecute the command on the remote host.- Overrides:
- executein class- Task
- Throws:
- BuildException- Most likely a network error or bad parameter.
 
 
-