|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tools.ant.ProjectComponent org.apache.tools.ant.Task org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
public abstract class SSHBase
Base class for Ant tasks using jsch.
Field Summary |
---|
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
SSHBase()
Constructor for SSHBase. |
Method Summary | |
---|---|
boolean |
getFailonerror()
Get the failonerror flag. |
java.lang.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 com.jcraft.jsch.Session |
openSession()
Open an ssh seession. |
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 |
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. |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, 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.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener |
---|
log |
Constructor Detail |
---|
public SSHBase()
Method Detail |
---|
public 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 occuries,
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 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 Task
BuildException
- on errorprotected com.jcraft.jsch.Session openSession() throws com.jcraft.jsch.JSchException
com.jcraft.jsch.JSchException
- on errorprotected SSHUserInfo getUserInfo()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |