Save This Page
Home » apache-ant-1.7.1-src » org.apache.tools » ant » taskdefs » optional » ssh » [javadoc | source]
org.apache.tools.ant.taskdefs.optional.ssh
public class: SSHExec [javadoc | source]
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:
    LogListener, Cloneable

Executes a command on a remote machine via ssh.
Fields inherited from org.apache.tools.ant.Task:
target,  taskName,  taskType,  wrapper
Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description
Constructor:
 public SSHExec() 
Method from org.apache.tools.ant.taskdefs.optional.ssh.SSHExec Summary:
execute,   setAppend,   setCommand,   setCommandResource,   setOutput,   setOutputproperty,   setTimeout
Methods from 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 from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   getWrapper,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   isInvalid,   log,   log,   log,   log,   markInvalid,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType
Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tools.ant.taskdefs.optional.ssh.SSHExec Detail:
 public  void execute() throws BuildException 
    Execute the command on the remote host.
 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.
 public  void setCommand(String command) 
    Sets the command to execute on the remote host.
 public  void setCommandResource(String f) 
    Sets a commandResource from a file
 public  void setOutput(File output) 
    If used, stores the output of the command to the given file.
 public  void setOutputproperty(String property) 
    If set, the output of the command will be stored in the given property.
 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".