org.apache.tools.ant.taskdefs.optional.ssh

Class SSHBase

Implemented Interfaces:
LogListener
Known Direct Subclasses:
Scp, SSHExec

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.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

SSHBase()
Constructor for SSHBase.

Method Summary

boolean
getFailonerror()
String
getHost()
int
getPort()
protected SSHUserInfo
getUserInfo()
boolean
getVerbose()
void
init()
Called by the project to let the task initialize properly.
protected Session
openSession()
void
setFailonerror(boolean failure)
void
setHost(String host)
Remote host, either DNS name or IP.
void
setKeyfile(String keyfile)
Sets the keyfile for the user.
void
setKnownhosts(String knownHosts)
Sets the path to the file that has the identities of all known hosts.
void
setPassphrase(String passphrase)
Sets the passphrase for the users key.
void
setPassword(String password)
Sets the password for the user.
void
setPort(int port)
Changes the port used to connect to the remote host.
void
setTrust(boolean yesOrNo)
Setting this to true trusts hosts whose identity is unknown.
void
setUsername(String username)
Username known to remote host.
void
setVerbose(boolean failure)

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Constructor Details

SSHBase

public SSHBase()
Constructor for SSHBase.

Method Details

getFailonerror

public boolean getFailonerror()

getHost

public String getHost()

getPort

public int getPort()

getUserInfo

protected SSHUserInfo getUserInfo()

getVerbose

public boolean getVerbose()
Since:
Ant 1.6.2

init

public void init()
            throws BuildException
Called by the project to let the task initialize properly. The default implementation is a no-op.
Overrides:
init in interface Task
Throws:
BuildException - if something goes wrong with the build

openSession

protected Session openSession()
            throws JSchException

setFailonerror

public void setFailonerror(boolean failure)

setHost

public void setHost(String host)
Remote host, either DNS name or IP.
Parameters:
host - The new host value

setKeyfile

public void setKeyfile(String keyfile)
Sets the keyfile for the user.
Parameters:
keyfile - The new keyfile value

setKnownhosts

public void setKnownhosts(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.

setPassphrase

public void setPassphrase(String passphrase)
Sets the passphrase for the users key.
Parameters:
passphrase - The new passphrase value

setPassword

public void setPassword(String password)
Sets the password for the user.
Parameters:
password - The new password value

setPort

public void setPort(int port)
Changes the port used to connect to the remote host.
Parameters:
port - port number of remote host.

setTrust

public void setTrust(boolean yesOrNo)
Setting this to true trusts hosts whose identity is unknown.
Parameters:
yesOrNo - if true trust the identity of unknown hosts.

setUsername

public void setUsername(String username)
Username known to remote host.
Parameters:
username - The new username value

setVerbose

public void setVerbose(boolean failure)
Since:
Ant 1.6.2

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.