org.apache.tools.ant.taskdefs.optional.ssh
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:

java.lang.Cloneable, LogListener

public class SSHExec
extends SSHBase

Executes a command on a remote machine via ssh.

Since:

Ant 1.6 (created February 2, 2003)

Field Summary

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

Constructor Summary

SSHExec()
Constructor for SSHExecTask.

Method Summary

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	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	setTimeout(long timeout) The connection can be dropped after a specified number of milliseconds.

Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase

getFailonerror, getHost, getPort, getUserInfo, getVerbose, init, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setTrust, setUsername, setVerbose

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, 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

Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener

log

Constructor Detail

SSHExec

public SSHExec()

Constructor for SSHExecTask.

Method Detail

setCommand

public void setCommand(java.lang.String command)

Sets the command to execute on the remote host.

Parameters:

command - The new command value

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

setOutput

public void setOutput(java.io.File output)

If used, stores the output of the command to the given file.

Parameters:

output - The file to write to.

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.

setOutputproperty

public void setOutputproperty(java.lang.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.

execute

public void execute()
             throws BuildException

Execute the command on the remote host.

Overrides:

execute in class Task

Throws:

BuildException - Most likely a network error or bad parameter.