public class ExtSSHExec
extends org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
Modifier and Type | Class and Description |
---|---|
static interface |
ExtSSHExec.Disconnectable
Allows disconnecting the ssh connection
|
static interface |
ExtSSHExec.DisconnectHolder
Interface for receiving access to Disconnectable
|
Constructor and Description |
---|
ExtSSHExec()
Constructor for SSHExecTask.
|
Modifier and Type | Method and Description |
---|---|
void |
addEnv(org.apache.tools.ant.types.Environment.Variable env)
Add an Env element
|
void |
execute()
Execute the command on the remote host.
|
int |
getAntLogLevel() |
ExtSSHExec.DisconnectHolder |
getDisconnectHolder()
Return the disconnectHolder
|
int |
getExitStatus()
Return exitStatus of the remote execution, after it has finished or failed.
|
java.io.InputStream |
getInputStream() |
java.lang.String |
getKeyfile() |
java.lang.String |
getKnownhosts() |
PluginLogger |
getPluginLogger() |
java.io.OutputStream |
getSecondaryStream() |
java.util.Map<java.lang.String,java.lang.String> |
getSshConfig() |
java.io.InputStream |
getSshKeyData() |
long |
getTimeout() |
org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo |
getUserInfo() |
protected com.jcraft.jsch.Session |
openSession()
Open an ssh seession.
|
void |
setAllocatePty(boolean b)
Allocate a Pseudo-Terminal.
|
void |
setAntLogLevel(int antLogLevel) |
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 |
setCommandResource(java.lang.String f)
Sets a commandResource from a file
|
void |
setDisconnectHolder(ExtSSHExec.DisconnectHolder disconnectHolder)
Set a disconnectHolder
|
void |
setInput(java.io.File input)
If used, the content of the file is piped to the remote command
|
void |
setInputProperty(java.lang.String inputProperty)
If used, the content of the property is piped to the remote command
|
void |
setInputStream(java.io.InputStream inputStream)
Set an inputstream for pty input to the session
|
void |
setKnownhosts(java.lang.String knownHosts)
Sets the path to the file that has the identities of
all known hosts.
|
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 |
setPluginLogger(PluginLogger logger) |
void |
setSecondaryStream(java.io.OutputStream secondaryStream)
Set a secondary outputstream to read from the connection
|
void |
setSshConfig(java.util.Map<java.lang.String,java.lang.String> config) |
void |
setSshKeyData(java.io.InputStream sshKeyData) |
void |
setTimeout(long timeout)
The connection can be dropped after a specified number of
milliseconds.
|
getFailonerror, getHost, getPort, getVerbose, init, setFailonerror, setHost, setKeyfile, setPassphrase, setPassword, setPort, setTrust, setUsername, setVerbose
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getHost, getPort, getVerbose, setFailonerror, setHost, setKeyfile, setPassphrase, setPassword, setPort, setProject, setTrust, setUsername, setVerbose
public void setCommand(java.lang.String command)
command
- The new command valuepublic void setCommandResource(java.lang.String f)
f
- the value to use.public void setTimeout(long timeout)
timeout
- The new timeout value in secondspublic long getTimeout()
public void setOutput(java.io.File output)
output
- The file to write to.public void setInput(java.io.File input)
input
- The file which provides the input data for the remote commandpublic void setInputProperty(java.lang.String inputProperty)
inputProperty
- The property which contains the input data for the remote command.public void setAppend(boolean append)
setOutput
. Default is false, that is, overwrite
the file.append
- True to append to an existing file, false to overwrite.public void setOutputproperty(java.lang.String property)
property
- The name of the property in which the command output
will be stored.public void setAllocatePty(boolean b)
b
- if true, allocate the pty. (default falsepublic int getExitStatus()
public void addEnv(org.apache.tools.ant.types.Environment.Variable env)
env
- elementpublic ExtSSHExec.DisconnectHolder getDisconnectHolder()
public void setDisconnectHolder(ExtSSHExec.DisconnectHolder disconnectHolder)
public PluginLogger getPluginLogger()
public void setPluginLogger(PluginLogger logger)
public int getAntLogLevel()
public void setAntLogLevel(int antLogLevel)
public java.util.Map<java.lang.String,java.lang.String> getSshConfig()
public java.io.InputStream getSshKeyData()
public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
- Most likely a network error or bad parameter.public void setSshKeyData(java.io.InputStream sshKeyData)
public void setKnownhosts(java.lang.String knownHosts)
setKnownhosts
in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
knownHosts
- a path to the known hosts file.public void setSshConfig(java.util.Map<java.lang.String,java.lang.String> config)
protected com.jcraft.jsch.Session openSession() throws com.jcraft.jsch.JSchException
openSession
in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
com.jcraft.jsch.JSchException
- on errorpublic java.io.InputStream getInputStream()
public void setInputStream(java.io.InputStream inputStream)
public java.io.OutputStream getSecondaryStream()
public void setSecondaryStream(java.io.OutputStream secondaryStream)
public java.lang.String getKeyfile()
public java.lang.String getKnownhosts()
public org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo getUserInfo()
getUserInfo
in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase