org.apache.tools.ant.taskdefs.optional.ssh

Class SSHExec

public class SSHExec extends SSHBase

Executes a command on a remote machine via ssh.

Since: Ant 1.6 (created February 2, 2003)

Constructor Summary
SSHExec()
Constructor for SSHExecTask.
Method Summary
voidexecute()
Execute the command on the remote host.
voidsetAppend(boolean append)
Determines if the output is appended to the file given in setOutput.
voidsetCommand(String command)
Sets the command to execute on the remote host.
voidsetCommandResource(String f)
Sets a commandResource from a file
voidsetInput(File input)
If used, the content of the file is piped to the remote command
voidsetInputProperty(String inputProperty)
If used, the content of the property is piped to the remote command
voidsetInputString(String inputString)
If used, the string is piped to the remote command.
voidsetOutput(File output)
If 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.
voidsetTimeout(long timeout)
The connection can be dropped after a specified number of milliseconds.
voidsetUsePty(boolean b)
Whether a pseudo-tty should be allocated.

Constructor Detail

SSHExec

public SSHExec()
Constructor for SSHExecTask.

Method Detail

execute

public void execute()
Execute the command on the remote host.

Throws: BuildException Most likely a network error or bad parameter.

setAppend

public void setAppend(boolean append)
Determines if the output is appended to the file given in setOutput. Default is false, that is, overwrite the file.

Parameters: append True to append to an existing file, false to overwrite.

setCommand

public void setCommand(String command)
Sets the command to execute on the remote host.

Parameters: command The new command value

setCommandResource

public void setCommandResource(String f)
Sets a commandResource from a file

Parameters: f the value to use.

Since: Ant 1.7.1

setInput

public void setInput(File input)
If 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

setInputProperty

public void setInputProperty(String inputProperty)
If 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

setInputString

public void setInputString(String inputString)
If used, the string is piped to the remote command.

Parameters: inputString the input data for the remote command.

Since: Ant 1.8.3

setOutput

public void setOutput(File output)
If used, stores the output of the command to the given file.

Parameters: output The file to write to.

setOutputproperty

public void setOutputproperty(String property)
If 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.

setTimeout

public 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

setUsePty

public void setUsePty(boolean b)
Whether a pseudo-tty should be allocated.

Since: Apache Ant 1.8.3