add suppresssystemout attribute to optionally make sshexec silent PR 52070

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@1447370 13f79535-47bb-0310-9956-ffa450edef68

CONTRIBUTORS

@@ -143,6 +143,7 @@ Ignacio Coloma
 Ingenonsya France
 Ingmar Stein
 Irene Rusman
+Isaac Shabtay
 Ivan Ivanov
 J Bleijenbergh
 Jack J. Woehr
@@ -335,6 +336,7 @@ Steve Loughran
 Steve Morin
 Steve Wadsworth
 Steven E. Newton
+Sudheer Chigurupati
 Takashi Okamoto
 TAMURA Kent
 Taoufik Romdhane

WHATSNEW

@@ -117,6 +117,9 @@ Other changes:
  * Add the possibility to register a custom command line argument processor.
    See org.apache.tools.ant.ArgumentProcessor and manual/argumentprocessor.html
 
+ * add the possibility to suppress stdout in the sshexec task.
+   Bugzilla Report 50270.
+
 Changes from Ant 1.8.3 TO Ant 1.8.4
 ===================================
 

contributors.xml

@@ -596,6 +596,10 @@
     <first>Irene</first>
     <last>Rusman</last>
   </name>
+  <name>
+    <first>Isaac</first>
+    <last>Shabtay</last>
+  </name>
   <name>
     <first>Ivan</first>
     <last>Ivanov</last>
@@ -1347,6 +1351,10 @@
     <middle>E.</middle>
     <last>Newton</last>
   </name>
+  <name>
+    <first>Sudheer</first>
+    <last>Chigurupati</last>
+  </name>
   <name>
     <first>Takashi</first>
     <last>Okamoto</last>

manual/Tasks/sshexec.html

@@ -115,6 +115,12 @@ and won't work with versions of jsch earlier than
      <td valign="top">Passphrase for your private key.</td>
      <td valign="top" align="center">No, defaults to an empty string.</td>
   </tr>
+  <tr>
+    <td valign="top">suppresssystemout</td>
+    <td valign="top">Whether to suppress system out.
+      <em>since Ant 1.9.0</em></td>
+    <td align="center" valign="top">No, defaults to false</td>
+  </tr>
   <tr>
     <td valign="top">output</td>
     <td valign="top">Name of a file to which to write the output.</td>

src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java

@@ -27,6 +27,7 @@ import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.io.OutputStream;
 import java.io.StringReader;
 
 import org.apache.tools.ant.BuildException;
@@ -72,6 +73,11 @@ public class SSHExec extends SSHBase {
     private static final String TIMEOUT_MESSAGE =
         "Timeout period exceeded, connection dropped.";
 
+    /**
+     * To supress writing logs to System.out
+     */
+    private boolean suppressSystemOut = false;
+    
     /**
      * Constructor for SSHExecTask.
      */
@@ -180,12 +186,22 @@ public class SSHExec extends SSHBase {
         usePty = b;
     }
 
+    /**
+     * If suppressSystemOut is <code>true</code>, output will not be sent to System.out<br/>
+     * If suppressSystemOut is <code>false</code>, normal behavior
+     * @since Ant 1.9.0
+     */
+    public void setSuppressSystemOut(boolean suppressSystemOut)
+    {
+        this.suppressSystemOut = suppressSystemOut;
+    }
     /**
      * Execute the command on the remote host.
      *
      * @exception BuildException  Most likely a network error or bad parameter.
      */
     public void execute() throws BuildException {
+        
         if (getHost() == null) {
             throw new BuildException("Host is required.");
         }
@@ -262,9 +278,7 @@ public class SSHExec extends SSHBase {
     private void executeCommand(Session session, String cmd, StringBuffer sb)
         throws BuildException {
         ByteArrayOutputStream out = new ByteArrayOutputStream();
-        TeeOutputStream tee =
-            new TeeOutputStream(out,
-                                KeepAliveOutputStream.wrapSystemOut());
+        OutputStream tee = suppressSystemOut ? out : new TeeOutputStream(out, KeepAliveOutputStream.wrapSystemOut());
 
         InputStream istream = null ;
         if (inputFile != null) {
@@ -407,4 +421,5 @@ public class SSHExec extends SSHBase {
             }
         }
     }
-}
+
+}