Class SSHBase
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- LogListener
 - Direct Known Subclasses:
- Scp,- SSHExec,- SSHSession
 
 public abstract class SSHBase extends Task implements LogListener Base class for Ant tasks using jsch.- Since:
- Ant 1.6
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description SSHBase()Constructor for SSHBase.
 - 
Method SummaryModifier and Type Method Description booleangetFailonerror()Get the failonerror flag.java.lang.StringgetHost()Get the host.intgetPort()Get the port attribute.intgetServerAliveCountMax()Get the serverAliveCountMax value.intgetServerAliveIntervalSeconds()Get the serverAliveIntervalSeconds value in seconds.protected SSHUserInfogetUserInfo()Get the user information.booleangetVerbose()Get the verbose flag.voidinit()Initialize the task.protected com.jcraft.jsch.SessionopenSession()Open an ssh session.voidsetFailonerror(boolean failure)Set the failonerror flag.voidsetHost(java.lang.String host)Remote host, either DNS name or IP.voidsetKeyfile(java.lang.String keyfile)Sets the keyfile for the user.voidsetKnownhosts(java.lang.String knownHosts)Sets the path to the file that has the identities of all known hosts.voidsetPassphrase(java.lang.String passphrase)Sets the passphrase for the users key.voidsetPassword(java.lang.String password)Sets the password for the user.voidsetPort(int port)Changes the port used to connect to the remote host.voidsetServerAliveCountMax(int countMax)Set the serverAliveCountMax value.voidsetServerAliveIntervalSeconds(int interval)Set the serverAliveIntervalSeconds value in seconds.voidsetTrust(boolean yesOrNo)Setting this to true trusts hosts whose identity is unknown.voidsetUsername(java.lang.String username)Username known to remote host.voidsetVerbose(boolean verbose)Set the verbose flag.- 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, execute, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListenerlog
 
- 
 
- 
- 
- 
Method Detail- 
setHostpublic void setHost(java.lang.String host) Remote host, either DNS name or IP.- Parameters:
- host- The new host value
 
 - 
getHostpublic java.lang.String getHost() Get the host.- Returns:
- the host
 
 - 
setFailonerrorpublic void setFailonerror(boolean failure) Set the failonerror flag. Default is true- Parameters:
- failure- if true throw a build exception when a failure occurs, otherwise just log the failure and continue
 
 - 
getFailonerrorpublic boolean getFailonerror() Get the failonerror flag.- Returns:
- the failonerror flag
 
 - 
setVerbosepublic void setVerbose(boolean verbose) Set the verbose flag.- Parameters:
- verbose- if true output more verbose logging
- Since:
- Ant 1.6.2
 
 - 
getVerbosepublic boolean getVerbose() Get the verbose flag.- Returns:
- the verbose flag
- Since:
- Ant 1.6.2
 
 - 
setServerAliveCountMaxpublic void setServerAliveCountMax(int countMax) Set the serverAliveCountMax value.- Parameters:
- countMax- int
- Since:
- Ant 1.9.7
 
 - 
getServerAliveCountMaxpublic int getServerAliveCountMax() Get the serverAliveCountMax value.- Returns:
- the serverAliveCountMax value
- Since:
- Ant 1.9.7
 
 - 
setServerAliveIntervalSecondspublic void setServerAliveIntervalSeconds(int interval) Set the serverAliveIntervalSeconds value in seconds.- Parameters:
- interval- int
- Since:
- Ant 1.9.7
 
 - 
getServerAliveIntervalSecondspublic int getServerAliveIntervalSeconds() Get the serverAliveIntervalSeconds value in seconds.- Returns:
- the serverAliveIntervalSeconds value in seconds
- Since:
- Ant 1.9.7
 
 - 
setUsernamepublic void setUsername(java.lang.String username) Username known to remote host.- Parameters:
- username- The new username value
 
 - 
setPasswordpublic void setPassword(java.lang.String password) Sets the password for the user.- Parameters:
- password- The new password value
 
 - 
setKeyfilepublic void setKeyfile(java.lang.String keyfile) Sets the keyfile for the user.- Parameters:
- keyfile- The new keyfile value
 
 - 
setPassphrasepublic void setPassphrase(java.lang.String passphrase) Sets the passphrase for the users key.- Parameters:
- passphrase- The new passphrase value
 
 - 
setKnownhostspublic void setKnownhosts(java.lang.String knownHosts) Sets the path to the file that has the identities of all known hosts. This is used by SSH protocol to validate the identity of the host. The default is ${user.home}/.ssh/known_hosts.- Parameters:
- knownHosts- a path to the known hosts file.
 
 - 
setTrustpublic void setTrust(boolean yesOrNo) Setting this to true trusts hosts whose identity is unknown.- Parameters:
- yesOrNo- if true trust the identity of unknown hosts.
 
 - 
setPortpublic void setPort(int port) Changes the port used to connect to the remote host.- Parameters:
- port- port number of remote host.
 
 - 
getPortpublic int getPort() Get the port attribute.- Returns:
- the port
 
 - 
initpublic void init() throws BuildExceptionInitialize the task. This initializes the known hosts and sets the default port.- Overrides:
- initin class- Task
- Throws:
- BuildException- on error
 
 - 
openSessionprotected com.jcraft.jsch.Session openSession() throws com.jcraft.jsch.JSchExceptionOpen an ssh session.- Returns:
- the opened session
- Throws:
- com.jcraft.jsch.JSchException- on error
 
 - 
getUserInfoprotected SSHUserInfo getUserInfo() Get the user information.- Returns:
- the user information
 
 
- 
 
-