Mailing-List: contact dev-help@ant.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Ant Developers List" <dev@ant.apache.org>
Date: 8 Jul 2005 13:38:00 -0000
Message-ID: <20050708133800.60079.qmail@minotaur.apache.org>
From: peterreilly@apache.org
To: ant-cvs@apache.org
Subject: cvs commit: ant/src/main/org/apache/tools/ant/taskdefs/optional/ssh
 SSHBase.java

peterreilly    2005/07/08 06:38:00

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/ssh
                        SSHBase.java
  Log:
  mostly javadoc
  
  Revision  Changes    Path
  1.14      +38 -2     ant/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.java
  
  Index: SSHBase.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.java,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- SSHBase.java	13 Jun 2005 07:30:26 -0000	1.13
  +++ SSHBase.java	8 Jul 2005 13:37:59 -0000	1.14
  @@ -59,26 +59,44 @@
           this.host = host;
       }
   
  +    /**
  +     * Get the host.
  +     * @return the host
  +     */
       public String getHost() {
           return host;
       }
   
  +    /**
  +     * 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
  +     */
       public void setFailonerror(boolean failure) {
           failOnError = failure;
       }
   
  +    /**
  +     * Get the failonerror flag.
  +     * @return the failonerror flag
  +     */
       public boolean getFailonerror() {
           return failOnError;
       }
   
       /**
  +     * Set the verbose flag.
  +     * @param verbose if true output more verbose logging
        * @since Ant 1.6.2
        */
  -    public void setVerbose(boolean failure) {
  -        verbose = failure;
  +    public void setVerbose(boolean verbose) {
  +        this.verbose = verbose;
       }
   
       /**
  +     * Get the verbose flag.
  +     * @return the verbose flag
        * @since Ant 1.6.2
        */
       public boolean getVerbose() {
  @@ -152,16 +170,30 @@
           this.port = port;
       }
   
  +    /**
  +     * Get the port attribute.
  +     * @return the port
  +     */
       public int getPort() {
           return port;
       }
   
  +    /**
  +     * Initialize the task.
  +     * This initializizs the known hosts and sets the default port.
  +     * @throws BuildException on error
  +     */
       public void init() throws BuildException {
           super.init();
           this.knownHosts = System.getProperty("user.home") + "/.ssh/known_hosts";
           this.port = SSH_PORT;
       }
   
  +    /**
  +     * Open an ssh seession.
  +     * @return the opened session
  +     * @throws JSchException on error
  +     */
       protected Session openSession() throws JSchException {
           JSch jsch = new JSch();
           if (null != userInfo.getKeyfile()) {
  @@ -180,6 +212,10 @@
           return session;
       }
   
  +    /**
  +     * Get the user information.
  +     * @return the user information
  +     */
       protected SSHUserInfo getUserInfo() {
           return userInfo;
       }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org