|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
org.apache.tools.ant.taskdefs.optional.ssh.SSHSession
public class SSHSession
Establishes an ssh session with a remote machine, optionally establishing port forwarding, then executes any nested task(s) before closing the session.
| Nested Class Summary | |
|---|---|
class |
SSHSession.LocalTunnel
|
static class |
SSHSession.NestedSequential
The class corresponding to the sequential nested element. |
class |
SSHSession.RemoteTunnel
|
| 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 | |
|---|---|
SSHSession()
|
|
| Method Summary | |
|---|---|
void |
addTask(Task nestedTask)
Add a nested task to Sequential. |
SSHSession.LocalTunnel |
createLocalTunnel()
|
SSHSession.RemoteTunnel |
createRemoteTunnel()
|
SSHSession.NestedSequential |
createSequential()
This is the sequential nested element of the macrodef. |
void |
execute()
Establish the ssh session and execute all nestedTasks |
void |
setLocaltunnels(java.lang.String tunnels)
Changes the comma-delimited list of local tunnels to establish on the connection. |
void |
setRemotetunnels(java.lang.String tunnels)
Changes the comma-delimited list of remote tunnels to establish on the connection. |
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 |
|---|
public SSHSession()
| Method Detail |
|---|
public void addTask(Task nestedTask)
nestedTask - Nested task to execute Sequential
public void setTimeout(long timeout)
timeout - The new timeout value in secondspublic void setLocaltunnels(java.lang.String tunnels)
tunnels - a comma-delimited list of lport:rhost:rport
tunnel specificationspublic void setRemotetunnels(java.lang.String tunnels)
tunnels - a comma-delimited list of rport:lhost:lport
tunnel specifications
public void execute()
throws BuildException
execute in class TaskBuildException - if one of the nested tasks fails, or
network error or bad parameter.public SSHSession.LocalTunnel createLocalTunnel()
public SSHSession.RemoteTunnel createRemoteTunnel()
public SSHSession.NestedSequential createSequential()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||