java.lang.Cloneable, LogListenerScp, SSHExec, SSHSessionpublic abstract class SSHBase extends Task implements LogListener
description, location, project| Constructor | Description |
|---|---|
SSHBase() |
Constructor for SSHBase.
|
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
getFailonerror() |
Get the failonerror flag.
|
java.lang.String |
getHost() |
Get the host.
|
int |
getPort() |
Get the port attribute.
|
int |
getServerAliveCountMax() |
Get the serverAliveCountMax value.
|
int |
getServerAliveIntervalSeconds() |
Get the serverAliveIntervalSeconds value in seconds.
|
protected SSHUserInfo |
getUserInfo() |
Get the user information.
|
boolean |
getVerbose() |
Get the verbose flag.
|
void |
init() |
Initialize the task.
|
protected com.jcraft.jsch.Session |
openSession() |
Open an ssh session.
|
void |
setFailonerror(boolean failure) |
Set the failonerror flag.
|
void |
setHost(java.lang.String host) |
Remote host, either DNS name or IP.
|
void |
setKeyfile(java.lang.String keyfile) |
Sets the keyfile for the user.
|
void |
setKnownhosts(java.lang.String knownHosts) |
Sets the path to the file that has the identities of
all known hosts.
|
void |
setPassphrase(java.lang.String passphrase) |
Sets the passphrase for the users key.
|
void |
setPassword(java.lang.String password) |
Sets the password for the user.
|
void |
setPort(int port) |
Changes the port used to connect to the remote host.
|
void |
setServerAliveCountMax(int countMax) |
Set the serverAliveCountMax value.
|
void |
setServerAliveIntervalSeconds(int interval) |
Set the serverAliveIntervalSeconds value in seconds.
|
void |
setTrust(boolean yesOrNo) |
Setting this to true trusts hosts whose identity is unknown.
|
void |
setUsername(java.lang.String username) |
Username known to remote host.
|
void |
setVerbose(boolean verbose) |
Set the verbose flag.
|
logequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getDescription, getLocation, getProject, setDescription, setLocation, setProjectbindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypepublic void setHost(java.lang.String host)
host - The new host valuepublic java.lang.String getHost()
public void setFailonerror(boolean failure)
failure - if true throw a build exception when a failure occurs,
otherwise just log the failure and continuepublic boolean getFailonerror()
public void setVerbose(boolean verbose)
verbose - if true output more verbose loggingpublic boolean getVerbose()
public void setServerAliveCountMax(int countMax)
countMax - intpublic int getServerAliveCountMax()
public void setServerAliveIntervalSeconds(int interval)
interval - intpublic int getServerAliveIntervalSeconds()
public void setUsername(java.lang.String username)
username - The new username valuepublic void setPassword(java.lang.String password)
password - The new password valuepublic void setKeyfile(java.lang.String keyfile)
keyfile - The new keyfile valuepublic void setPassphrase(java.lang.String passphrase)
passphrase - The new passphrase valuepublic void setKnownhosts(java.lang.String knownHosts)
knownHosts - a path to the known hosts file.public void setTrust(boolean yesOrNo)
yesOrNo - if true trust the identity of unknown hosts.public void setPort(int port)
port - port number of remote host.public int getPort()
public void init()
throws BuildException
init in class TaskBuildException - on errorprotected com.jcraft.jsch.Session openSession()
throws com.jcraft.jsch.JSchException
com.jcraft.jsch.JSchException - on errorprotected SSHUserInfo getUserInfo()