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

Class SSHBase

public abstract class SSHBase extends Task implements LogListener

Base class for Ant tasks using jsch.

Since: Ant 1.6

Constructor Summary
	SSHBase() Constructor for SSHBase.

Method Summary
boolean	getFailonerror() Get the failonerror flag.
String	getHost() Get the host.
int	getPort() Get the port attribute.
protected SSHUserInfo	getUserInfo() Get the user information.
boolean	getVerbose() Get the verbose flag.
void	init() Initialize the task.
protected Session	openSession() Open an ssh seession.
void	setFailonerror(boolean failure) Set the failonerror flag.
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 verbose) Set the verbose flag.

Constructor Detail

SSHBase

public SSHBase()

Constructor for SSHBase.

Method Detail

getFailonerror

public boolean getFailonerror()

Get the failonerror flag.

Returns: the failonerror flag

getHost

public String getHost()

Get the host.

Returns: the host

getPort

public int getPort()

Get the port attribute.

Returns: the port

getUserInfo

protected SSHUserInfo getUserInfo()

Get the user information.

Returns: the user information

getVerbose

public boolean getVerbose()

Get the verbose flag.

Returns: the verbose flag

Since: Ant 1.6.2

init

public void init()

Initialize the task. This initializizs the known hosts and sets the default port.

Throws: BuildException on error

openSession

protected Session openSession()

Open an ssh seession.

Returns: the opened session

Throws: JSchException on error

setFailonerror

public void setFailonerror(boolean failure)

Set the failonerror flag. Default is true

Parameters: failure if true throw a build exception when a failure occuries, otherwise just log the failure and continue

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.