File	Doc	Category	Size	Date	Package
SSHBase.java	API Doc	Apache Ant 1.70	5788	Wed Dec 13 06:16:20 GMT 2006	org.apache.tools.ant.taskdefs.optional.ssh

SSHBase

• java.lang.Object
  • org.apache.tools.ant.Task

Fields Summary
private static final int	SSH_PORT Default listen port for SSH daemon
private String	host
private String	knownHosts
private int	port
private boolean	failOnError
private boolean	verbose
private SSHUserInfo	userInfo

Constructors Summary
public SSHBase() Constructor for SSHBase. super(); userInfo = new SSHUserInfo();

Methods Summary
public boolean	getFailonerror() Get the failonerror flag. return the failonerror flag return failOnError;
public java.lang.String	getHost() Get the host. return the host return host;
public int	getPort() Get the port attribute. return the port return port;
protected SSHUserInfo	getUserInfo() Get the user information. return the user information return userInfo;
public boolean	getVerbose() Get the verbose flag. return the verbose flag since Ant 1.6.2 return verbose;
public void	init() Initialize the task. This initializizs the known hosts and sets the default port. throws BuildException on error super.init(); this.knownHosts = System.getProperty("user.home") + "/.ssh/known_hosts"; this.port = SSH_PORT;
protected com.jcraft.jsch.Session	openSession() Open an ssh seession. return the opened session throws JSchException on error JSch jsch = new JSch(); if (null != userInfo.getKeyfile()) { jsch.addIdentity(userInfo.getKeyfile()); } if (!userInfo.getTrust() && knownHosts != null) { log("Using known hosts: " + knownHosts, Project.MSG_DEBUG); jsch.setKnownHosts(knownHosts); } Session session = jsch.getSession(userInfo.getName(), host, port); session.setUserInfo(userInfo); log("Connecting to " + host + ":" + port); session.connect(); return session;
public void	setFailonerror(boolean failure) Set the failonerror flag. Default is true param failure if true throw a build exception when a failure occuries, otherwise just log the failure and continue failOnError = failure;
public void	setHost(java.lang.String host) Remote host, either DNS name or IP. param host The new host value this.host = host;
public void	setKeyfile(java.lang.String keyfile) Sets the keyfile for the user. param keyfile The new keyfile value userInfo.setKeyfile(keyfile);
public 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. param knownHosts a path to the known hosts file. this.knownHosts = knownHosts;
public void	setPassphrase(java.lang.String passphrase) Sets the passphrase for the users key. param passphrase The new passphrase value userInfo.setPassphrase(passphrase);
public void	setPassword(java.lang.String password) Sets the password for the user. param password The new password value userInfo.setPassword(password);
public void	setPort(int port) Changes the port used to connect to the remote host. param port port number of remote host. this.port = port;
public void	setTrust(boolean yesOrNo) Setting this to true trusts hosts whose identity is unknown. param yesOrNo if true trust the identity of unknown hosts. userInfo.setTrust(yesOrNo);
public void	setUsername(java.lang.String username) Username known to remote host. param username The new username value userInfo.setName(username);
public void	setVerbose(boolean verbose) Set the verbose flag. param verbose if true output more verbose logging since Ant 1.6.2 this.verbose = verbose;