Add openFile to support stream way to get remote file, a callback interface is added for reading inputstream

Author: scottfrederick

cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/ClientHttpResponseCallback.java

@@ -0,0 +1,14 @@
+package org.cloudfoundry.client.lib;
+
+import java.io.IOException;
+
+import org.springframework.http.client.ClientHttpResponse;
+
+/**
+ * Callback class while the client receives the server response.
+ * 
+ */
+public interface ClientHttpResponseCallback {
+
+	public void onClientHttpResponse(ClientHttpResponse clientHttpResponse) throws IOException;
+}

cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/CloudFoundryClient.java

@@ -18,6 +18,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.io.InputStream;
 import java.net.URL;
 import java.util.List;
 import java.util.Map;
@@ -358,6 +359,10 @@ public String getFile(String appName, int instanceIndex, String filePath, int st
 		return cc.getFile(appName, instanceIndex, filePath, startPosition, endPosition - 1);
 	}
 
+	public void openFile(String appName, int instanceIndex, String filePath, ClientHttpResponseCallback callback) {
+		cc.openFile(appName, instanceIndex, filePath, callback);
+	}
+
 	public String getFileTail(String appName, int instanceIndex, String filePath, int length) {
 		Assert.isTrue(length > 0, length + " is not a valid value for length, it should be 1 or greater.");
 		return cc.getFile(appName, instanceIndex, filePath, -1, length);

cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/rest/CloudControllerClient.java

@@ -24,6 +24,7 @@
 import java.util.UUID;
 
 import org.cloudfoundry.client.lib.ApplicationLogListener;
+import org.cloudfoundry.client.lib.ClientHttpResponseCallback;
 import org.cloudfoundry.client.lib.CloudCredentials;
 import org.cloudfoundry.client.lib.RestLogCallback;
 import org.cloudfoundry.client.lib.StartingInfo;
@@ -151,6 +152,8 @@ void createApplication(String appName, Staging staging, Integer disk, Integer me
 
 	String getFile(String appName, int instanceIndex, String filePath, int startPosition, int endPosition);
 
+	void openFile(String appName, int instanceIndex, String filePath, ClientHttpResponseCallback callback);
+
 	void bindService(String appName, String serviceName);
 
 	void unbindService(String appName, String serviceName);
@@ -171,6 +174,7 @@ void createApplication(String appName, Staging staging, Integer disk, Integer me
 
 	// Domains and routes management
 
+
 	List<CloudDomain> getDomainsForOrg();
 
 	List<CloudDomain> getDomains();
@@ -198,6 +202,4 @@ void createApplication(String appName, Staging staging, Integer disk, Integer me
 	void registerRestLogListener(RestLogCallback callBack);
 
 	void unRegisterRestLogListener(RestLogCallback callBack);
-
-    
 }

cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/rest/CloudControllerClientImpl.java

@@ -44,6 +44,7 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.cloudfoundry.client.lib.ApplicationLogListener;
+import org.cloudfoundry.client.lib.ClientHttpResponseCallback;
 import org.cloudfoundry.client.lib.CloudCredentials;
 import org.cloudfoundry.client.lib.CloudFoundryException;
 import org.cloudfoundry.client.lib.CloudOperationException;
@@ -250,6 +251,13 @@ public String getFile(String appName, int instanceIndex, String filePath, int st
 		return doGetFile(urlPath, appId, instanceIndex, filePath, startPosition, endPosition);
 	}
 
+
+	public void openFile(String appName, int instanceIndex, String filePath, ClientHttpResponseCallback callback) {
+		String urlPath = getFileUrlPath();
+		Object appId = getFileAppId(appName);
+		doOpenFile(urlPath, appId, instanceIndex, filePath, callback);
+	}
+
 	public void registerRestLogListener(RestLogCallback callBack) {
 		if (getRestTemplate() instanceof LoggingRestTemplate) {
 			((LoggingRestTemplate)getRestTemplate()).registerRestLogListener(callBack);
@@ -424,6 +432,13 @@ protected Map<String, String> doGetLogs(String urlPath, String appName, String i
 		return logs;
 	}
 
+	@SuppressWarnings("unchecked")
+	protected void doOpenFile(String urlPath, Object app, int instanceIndex, String filePath,
+			ClientHttpResponseCallback callback) {
+		getRestTemplate().execute(getUrl(urlPath), HttpMethod.GET, null, new ResponseExtractorWrapper(callback), app,
+				String.valueOf(instanceIndex), filePath);
+	}
+
 	protected String doGetFile(String urlPath, Object app, int instanceIndex, String filePath, int startPosition, int endPosition) {
 		return doGetFile(urlPath, app, String.valueOf(instanceIndex), filePath, startPosition, endPosition);
 	}
@@ -1740,4 +1755,18 @@ private boolean hasEmbeddedResource(Map<String, Object> resource, String resourc
 		return entity.containsKey(resourceKey) || entity.containsKey(resourceKey + "_url");
 	}
 
+	private static class ResponseExtractorWrapper implements ResponseExtractor {
+
+		private ClientHttpResponseCallback callback;
+
+		public ResponseExtractorWrapper(ClientHttpResponseCallback callback) {
+			this.callback = callback;
+		}
+
+		public Object extractData(ClientHttpResponse clientHttpResponse) throws IOException {
+			callback.onClientHttpResponse(clientHttpResponse);
+			return null;
+		}
+
+	}
 }

cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/rest/LoggingRestTemplate.java

@@ -57,8 +57,8 @@ protected <T> T doExecute(URI url, HttpMethod method, RequestCallback requestCal
 						public T extractData(ClientHttpResponse response) throws IOException {
 							httpStatus[0] = response.getStatusCode();
 							headers[0] = response.getHeaders();
-							if (responseExtractor != null) {
-								T data = responseExtractor.extractData(response);
+							T data = null;
+							if (responseExtractor != null && (data = responseExtractor.extractData(response)) != null) {
 								if (data instanceof String) {
 									message[0] = ((String)data).length() + " bytes";
 								} else if (data instanceof Map) {

cloudfoundry-client-lib/src/test/java/org/cloudfoundry/client/lib/CloudFoundryClientTest.java

@@ -15,6 +15,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.io.InputStream;
 import java.net.InetSocketAddress;
 import java.net.MalformedURLException;
 import java.net.URL;
@@ -31,6 +32,7 @@
 import java.util.UUID;
 import java.util.concurrent.atomic.AtomicInteger;
 
+import org.apache.commons.io.IOUtils;
 import org.apache.http.HttpHost;
 import org.apache.http.conn.params.ConnRoutePNames;
 import org.cloudfoundry.client.lib.domain.ApplicationStats;
@@ -1063,6 +1065,14 @@ public void getFile() throws Exception {
 		doGetFile(connectedClient, appName);
 	}
 
+	@Test
+	public void openFile() throws Exception {
+		String appName = namespacedAppName("simple_openFile");
+		createAndUploadAndStartSimpleSpringApp(appName);
+		boolean running = getInstanceInfosWithTimeout(appName, 1, true);
+		assertTrue("App failed to start", running);
+		doOpenFile(connectedClient, appName);
+	}
 
 	//
 	// Basic Services tests
@@ -1516,6 +1526,45 @@ private boolean getInstanceInfosWithTimeout(String appName, int count, boolean s
 		return pass;
 	}
 
+	private void doOpenFile(CloudFoundryClient client, String appName) throws Exception {
+		String appDir = "app";
+		String fileName = appDir + "/WEB-INF/web.xml";
+		String emptyPropertiesFileName = appDir + "/WEB-INF/classes/empty.properties";
+
+		// File is often not available immediately after starting an app... so
+		// allow up to 60 seconds wait
+		for (int i = 0; i < 60; i++) {
+			try {
+				client.getFile(appName, 0, fileName);
+				break;
+			} catch (HttpServerErrorException ex) {
+				Thread.sleep(1000);
+			}
+		}
+		// Test open file
+
+		client.openFile(appName, 0, fileName, new ClientHttpResponseCallback() {
+
+			public void onClientHttpResponse(ClientHttpResponse clientHttpResponse) throws IOException {
+				InputStream in = clientHttpResponse.getBody();
+				assertNotNull(in);
+				byte[] fileContents = IOUtils.toByteArray(in);
+				assertTrue(fileContents.length > 5);
+			}
+		});
+
+		client.openFile(appName, 0, emptyPropertiesFileName, new ClientHttpResponseCallback() {
+
+			public void onClientHttpResponse(ClientHttpResponse clientHttpResponse) throws IOException {
+				InputStream in = clientHttpResponse.getBody();
+				assertNotNull(in);
+				byte[] fileContents = IOUtils.toByteArray(in);
+				assertTrue(fileContents.length == 0);
+			}
+		});
+
+	}
+
 	private void doGetFile(CloudFoundryClient client, String appName) throws Exception {
 		String appDir = "app";
 		String fileName = appDir + "/WEB-INF/web.xml";