From 846df41cfc92db7cfe0c51ebae7ec682a6b70841 Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Thu, 6 Aug 2009 16:22:16 +0000
Subject: [PATCH] [274568] Dont use SftpMonitor for Streams transfer

---
 .../services/files/AbstractFileService.java   | 20 ++++++++++---------
 .../rse/services/files/IFileService.java      | 15 ++++++++++----
 2 files changed, 22 insertions(+), 13 deletions(-)

diff --git a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/AbstractFileService.java b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/AbstractFileService.java
index 43bf48c39a2..3f8b4e52dff 100644
--- a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/AbstractFileService.java
+++ b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/AbstractFileService.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation and others.
+ * Copyright (c) 2006, 2009 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -27,6 +27,7 @@
  * Martin Oberhuber (Wind River) - [226262] Make IService IAdaptable and add Javadoc
  * David Dykstal (IBM) - [221211] fix IFileService API for batch operations
  * Martin Oberhuber (Wind River) - [221211] Fix progress monitor and cancellation for multi operations
+ * Martin Oberhuber (Wind River) - [274568] Dont use SftpMonitor for Streams transfer
  *******************************************************************************/
 
 package org.eclipse.rse.services.files;
@@ -254,17 +255,19 @@ public abstract class AbstractFileService extends AbstractService implements IFi
 	}
 
 	/**
-	 * The default implementation returns <code>null</code>. Clients can override to return an input stream to the file.
-	 * @see org.eclipse.rse.services.files.IFileService#getInputStream(String, String, boolean, IProgressMonitor)
+	 * {@inheritDoc} The default implementation returns <code>null</code>.
+	 * Clients can override to return an input stream to the file.
+	 *
+	 * @see org.eclipse.rse.services.files.IFileService#getInputStream(String,
+	 *      String, boolean, IProgressMonitor)
 	 */
 	public InputStream getInputStream(String remoteParent, String remoteFile, boolean isBinary, IProgressMonitor monitor) throws SystemMessageException {
 		return null;
 	}
 
 	/**
-	 * Gets the output stream to write/append to a remote file. The default
-	 * implementation returns <code>null</code>. Clients can override to
-	 * return an output stream to the file.
+	 * {@inheritDoc} The default implementation returns <code>null</code>.
+	 * Clients can override to return an output stream to the file.
 	 *
 	 * @deprecated use
 	 *             {@link #getOutputStream(String, String, int, IProgressMonitor)}
@@ -275,9 +278,8 @@ public abstract class AbstractFileService extends AbstractService implements IFi
 	}
 
 	/**
-	 * Gets the output stream to write/append to a remote file. The default
-	 * implementation returns <code>null</code>. Clients can override to return
-	 * an output stream to the file.
+	 * {@inheritDoc} The default implementation returns <code>null</code>.
+	 * Clients can override to return an output stream to the file.
 	 *
 	 * @see org.eclipse.rse.services.files.IFileService#getOutputStream(String,
 	 *      String, int, IProgressMonitor)
diff --git a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileService.java b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileService.java
index 4a79fa3cc5b..078d6f3a866 100644
--- a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileService.java
+++ b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileService.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation and others.
+ * Copyright (c) 2006, 2009 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -27,6 +27,7 @@
  * David Dykstal (IBM) - [221211] fix IFileService API for batch operations
  * Radoslav Gerganov (ProSyst) - [230919] IFileService.delete() should not return a boolean
  * Martin Oberhuber (Wind River) - [234026] Clarify IFileService#createFolder() Javadocs
+ * Martin Oberhuber (Wind River) - [274568] Dont use SftpMonitor for Streams transfer
  *******************************************************************************/
 
 package org.eclipse.rse.services.files;
@@ -583,7 +584,9 @@ public interface IFileService extends IService
 	 * @param remoteFile the name of the remote file.
 	 * @param isBinary <code>true</code> if the file is a binary file,
 	 *            <code>false</code> otherwise.
-	 * @param monitor the progress monitor.
+	 * @param monitor the progress monitor. Only used for the process of opening
+	 *            the Stream. Implementations are not expected to use or update
+	 *            the monitor for actual Stream transfer operations.
 	 * @return the input stream to access the contents of the remote file.
 	 * @throws SystemMessageException if an error occurs.
 	 * @since org.eclipse.rse.services 2.0
@@ -598,7 +601,9 @@ public interface IFileService extends IService
 	 * @param remoteFile the name of the remote file.
 	 * @param isBinary <code>true</code> if the file is a binary file,
 	 *            <code>false</code> otherwise.
-	 * @param monitor the progress monitor.
+	 * @param monitor the progress monitor. Only used for the process of opening
+	 *            the Stream. Implementations are not expected to use or update
+	 *            the monitor for actual Stream transfer operations.
 	 * @return the input stream to access the contents of the remote file.
 	 * @throws SystemMessageException if an error occurs.
 	 * @since org.eclipse.rse.services 2.0
@@ -617,7 +622,9 @@ public interface IFileService extends IService
 	 * @param options bit wise or of option constants. Valid constants are
 	 *            {@link IFileService#APPEND}, {@link IFileService#TEXT_MODE},
 	 *            and {@link IFileService#NONE}
-	 * @param monitor the progress monitor.
+	 * @param monitor the progress monitor. Only used for the process of opening
+	 *            the Stream. Implementations are not expected to use or update
+	 *            the monitor for actual Stream transfer operations.
 	 * @return the input stream to access the contents of the remote file.
 	 * @throws SystemMessageException if an error occurs.
 	 * @since org.eclipse.rse.services 3.0