Changed streamRecentLogs() to block and return log entries as a list. Changed Gradle cfLogs task and Maven cf:logs goal to tail streaming logs. Added Gradle cfRecentLogs task and Maven cf:recentLogs goal.

Author: scottfrederick

Diff for: cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/ApplicationLogListener.java

@@ -1,54 +1,12 @@
 package org.cloudfoundry.client.lib;
 
-import java.util.Date;
+import org.cloudfoundry.client.lib.domain.ApplicationLog;
 
 public interface ApplicationLogListener {
-    void onMessage(ApplicationLog log);
-    
-    void onComplete();
+	void onMessage(ApplicationLog log);
 
-    void onError(Throwable exception);
-    
-    public static class ApplicationLog {
-        private String appId;
-        private String message;
-        private Date timestamp;
-        private MessageType messageType;
-        private String sourceName;
-        
-        public ApplicationLog(String appId, String message, Date timestamp, MessageType messageType, String sourceName) {
-            this.appId = appId;
-            this.message = message;
-            this.timestamp = timestamp;
-            this.messageType = messageType;
-            this.sourceName = sourceName;
-        }
+	void onComplete();
 
-        public String getAppId() {
-            return appId;
-        }
+	void onError(Throwable exception);
 
-        public String getMessage() {
-            return message;
-        }
-
-        public Date getTimestamp() {
-            return timestamp;
-        }
-
-        public MessageType getMessageType() {
-            return messageType;
-        }
-
-        public String getSourceName() {
-            return sourceName;
-        }
-        
-        @Override
-        public String toString() {
-            return String.format("%s [%s] %s (%s, %s)", appId, timestamp, message, messageType, sourceName);
-        }
-    }
-    
-    public enum MessageType { STDOUT, STDERR }
 }

Diff for: cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/CloudFoundryClient.java

@@ -18,13 +18,13 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.io.InputStream;
 import java.net.URL;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 import org.cloudfoundry.client.lib.archive.ApplicationArchive;
+import org.cloudfoundry.client.lib.domain.ApplicationLog;
 import org.cloudfoundry.client.lib.domain.ApplicationStats;
 import org.cloudfoundry.client.lib.domain.CloudApplication;
 import org.cloudfoundry.client.lib.domain.CloudApplication.DebugMode;
@@ -318,7 +318,7 @@ public void updateApplicationEnv(String appName, List<String> env) {
 	}
 
 	/**
-	 * @deprecated use {@link #streamLogs(String, ApplicationLogListener)} or {@link #streamRecentLogs(String, ApplicationLogListener)}
+	 * @deprecated use {@link #streamLogs(String, ApplicationLogListener)} or {@link #getRecentLogs(String)}
 	 */
 	public Map<String, String> getLogs(String appName) {
 		return cc.getLogs(appName);
@@ -328,10 +328,13 @@ public StreamingLogToken streamLogs(String appName, ApplicationLogListener liste
 	    return cc.streamLogs(appName, listener);
 	}
 
-    public StreamingLogToken streamRecentLogs(String appName, ApplicationLogListener listener) {
-        return cc.streamRecentLogs(appName, listener);
-    }
-	
+	public List<ApplicationLog> getRecentLogs(String appName) {
+		return cc.getRecentLogs(appName);
+	}
+
+	/**
+	 * @deprecated use {@link #streamLogs(String, ApplicationLogListener)} or {@link #getRecentLogs(String)}
+	 */
 	public Map<String, String> getCrashLogs(String appName) {
 		return cc.getCrashLogs(appName);
 	}

Diff for: cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/CloudFoundryOperations.java

@@ -23,6 +23,7 @@
 import java.util.Map;
 
 import org.cloudfoundry.client.lib.archive.ApplicationArchive;
+import org.cloudfoundry.client.lib.domain.ApplicationLog;
 import org.cloudfoundry.client.lib.domain.ApplicationStats;
 import org.cloudfoundry.client.lib.domain.CloudApplication;
 import org.cloudfoundry.client.lib.domain.CloudDomain;
@@ -354,7 +355,7 @@ public void createApplication(String appName, Staging staging, Integer disk, Int
 	 * @param appName name of the application
 	 * @return a Map containing the logs. The logs will be returned with the path to the log file used as the key and
 	 * the full content of the log file will be returned as a String value for the corresponding key.
-	 * @deprecated Use {@link #streamLogs(String, ApplicationLogListener)} or {@link #streamRecentLogs(String, ApplicationLogListener)}
+	 * @deprecated Use {@link #streamLogs(String, ApplicationLogListener)} or {@link #getRecentLogs(String)}
 	 */
 	Map<String, String> getLogs(String appName);
 
@@ -373,14 +374,12 @@ public void createApplication(String appName, Staging staging, Integer disk, Int
 	/**
 	 * Stream recent log entries.
 	 * 
-	 * Stream logs that were recently produced for an app. Once recent log entries have been notified,
-	 * the listener will not be notified any more.
-	 * 
-     * @param appName the name of the application
-     * @param listener listener object to be notified
-     * @return token than can be used to cancel listening for logs
+	 * Stream logs that were recently produced for an app.
+	 *
+	 * @param appName the name of the application
+	 * @return the list of recent log entries
 	 */
-	StreamingLogToken streamRecentLogs(String appName, ApplicationLogListener listener);
+	List<ApplicationLog> getRecentLogs(String appName);
 
 	/**
 	 * Get logs from most recent crash of the deployed application. The logs
@@ -390,6 +389,7 @@ public void createApplication(String appName, Staging staging, Integer disk, Int
 	 * @param appName name of the application
 	 * @return a Map containing the logs. The logs will be returned with the path to the log file used as the key and
 	 * the full content of the log file will be returned as a String value for the corresponding key.
+	 * @deprecated Use {@link #streamLogs(String, ApplicationLogListener)} or {@link #getRecentLogs(String)}
 	 */
 	Map<String, String> getCrashLogs(String appName);
 

Diff for: cloudfoundry-client-lib/src/main/java/org/cloudfoundry/client/lib/domain/ApplicationLog.java

@@ -0,0 +1,57 @@
+package org.cloudfoundry.client.lib.domain;
+
+
+import java.util.Date;
+
+public class ApplicationLog implements Comparable<ApplicationLog> {
+	public enum MessageType {STDOUT, STDERR}
+
+	private String appId;
+	private String message;
+	private Date timestamp;
+	private MessageType messageType;
+	private String sourceName;
+	private String sourceId;
+
+	public ApplicationLog(String appId, String message, Date timestamp, MessageType messageType, String sourceName, String sourceId) {
+		this.appId = appId;
+		this.message = message;
+		this.timestamp = timestamp;
+		this.messageType = messageType;
+		this.sourceName = sourceName;
+		this.sourceId = sourceId;
+	}
+
+	public String getAppId() {
+		return appId;
+	}
+
+	public String getMessage() {
+		return message;
+	}
+
+	public Date getTimestamp() {
+		return timestamp;
+	}
+
+	public MessageType getMessageType() {
+		return messageType;
+	}
+
+	public String getSourceName() {
+		return sourceName;
+	}
+
+	public String getSourceId() {
+		return sourceId;
+	}
+
+	public int compareTo(ApplicationLog o) {
+		return timestamp.compareTo(o.timestamp);
+	}
+
+	@Override
+	public String toString() {
+		return String.format("%s [%s] %s (%s, %s)", appId, timestamp, message, messageType, sourceName);
+	}
+}

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

@@ -31,6 +31,7 @@
 import org.cloudfoundry.client.lib.StreamingLogToken;
 import org.cloudfoundry.client.lib.UploadStatusCallback;
 import org.cloudfoundry.client.lib.archive.ApplicationArchive;
+import org.cloudfoundry.client.lib.domain.ApplicationLog;
 import org.cloudfoundry.client.lib.domain.ApplicationStats;
 import org.cloudfoundry.client.lib.domain.CloudApplication;
 import org.cloudfoundry.client.lib.domain.CloudDomain;
@@ -146,9 +147,9 @@ void createApplication(String appName, Staging staging, Integer disk, Integer me
 
 	StreamingLogToken streamLogs(String appName, ApplicationLogListener listener);
 
-    StreamingLogToken streamRecentLogs(String appName, ApplicationLogListener listener);
+	List<ApplicationLog> getRecentLogs(String appName);
 
-    Map<String, String> getCrashLogs(String appName);
+	Map<String, String> getCrashLogs(String appName);
 
 	String getFile(String appName, int instanceIndex, String filePath, int startPosition, int endPosition);
 

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

@@ -55,6 +55,7 @@
 import org.cloudfoundry.client.lib.archive.ApplicationArchive;
 import org.cloudfoundry.client.lib.archive.DirectoryApplicationArchive;
 import org.cloudfoundry.client.lib.archive.ZipApplicationArchive;
+import org.cloudfoundry.client.lib.domain.ApplicationLog;
 import org.cloudfoundry.client.lib.domain.ApplicationStats;
 import org.cloudfoundry.client.lib.domain.CloudApplication;
 import org.cloudfoundry.client.lib.domain.CloudDomain;
@@ -222,15 +223,24 @@ public Map<String, String> getLogs(String appName) {
 		String instance = String.valueOf(0);
 		return doGetLogs(urlPath, appName, instance);
 	}
-	
-	public StreamingLogToken streamRecentLogs(String appName, ApplicationLogListener listener) {
-	    return streamLoggregatorLogs(appName, listener, true);
+
+	public List<ApplicationLog> getRecentLogs(String appName) {
+		AccumulatingApplicationLogListener listener = new AccumulatingApplicationLogListener();
+		streamLoggregatorLogs(appName, listener, true);
+		synchronized (listener) {
+			try {
+				listener.wait();
+			} catch (InterruptedException e) {
+				// return any captured logs
+			}
+		}
+		return listener.getLogs();
+	}
+
+	public StreamingLogToken streamLogs(String appName, ApplicationLogListener listener) {
+		return streamLoggregatorLogs(appName, listener, false);
 	}
 
-    public StreamingLogToken streamLogs(String appName, ApplicationLogListener listener) {
-        return streamLoggregatorLogs(appName, listener, false);
-    }
-	
 	public Map<String, String> getCrashLogs(String appName) {
 		String urlPath = getFileUrlPath();
 		CrashesInfo crashes = getCrashes(appName);
@@ -1613,31 +1623,56 @@ private UUID getAppId(String appName) {
 		return guid;
 	}
 
-    private StreamingLogToken streamLoggregatorLogs(String appName, ApplicationLogListener listener, boolean recent) {
-        ClientEndpointConfig.Configurator configurator = new ClientEndpointConfig.Configurator() {
-            public void beforeRequest(Map<String,List<String>> headers) {
-                if (token != null) {
-                    headers.put(AUTHORIZATION_HEADER_KEY, Arrays.asList(getAuthorizationHeader()));
-                }
-            }
-        };
-        
-        UUID appId = getAppId(appName);
-        CloudInfo cloudInfo = getInfo();
-        String mode = recent ? "dump" : "tail";
-        URI loggregatorUri = loggregatorUriTemplate.expand(cloudInfo.getLoggregatorEndpoint(), mode, appId);
-        try {
-            WebSocketContainer container = ContainerProvider.getWebSocketContainer();
-            ClientEndpointConfig config = ClientEndpointConfig.Builder.create().configurator(configurator).build();
-            Session session = container.connectToServer(new LoggregatorEndpoint(listener), config, loggregatorUri);
-            return new StreamingLogTokenImpl(session);
-        } catch (DeploymentException e) {
-            throw new CloudOperationException(e);
-        } catch (IOException e) {
-            throw new CloudOperationException(e);
-        }
-    }
-	
+	private StreamingLogToken streamLoggregatorLogs(String appName, ApplicationLogListener listener, boolean recent) {
+		ClientEndpointConfig.Configurator configurator = new ClientEndpointConfig.Configurator() {
+			public void beforeRequest(Map<String, List<String>> headers) {
+				if (token != null) {
+					headers.put(AUTHORIZATION_HEADER_KEY, Arrays.asList(getAuthorizationHeader()));
+				}
+			}
+		};
+
+		UUID appId = getAppId(appName);
+		CloudInfo cloudInfo = getInfo();
+		String mode = recent ? "dump" : "tail";
+		URI loggregatorUri = loggregatorUriTemplate.expand(cloudInfo.getLoggregatorEndpoint(), mode, appId);
+		try {
+			WebSocketContainer container = ContainerProvider.getWebSocketContainer();
+			ClientEndpointConfig config = ClientEndpointConfig.Builder.create().configurator(configurator).build();
+			Session session = container.connectToServer(new LoggregatorEndpoint(listener), config, loggregatorUri);
+			return new StreamingLogTokenImpl(session);
+		} catch (DeploymentException e) {
+			throw new CloudOperationException(e);
+		} catch (IOException e) {
+			throw new CloudOperationException(e);
+		}
+	}
+
+	private class AccumulatingApplicationLogListener implements ApplicationLogListener {
+		private List<ApplicationLog> logs = new ArrayList<ApplicationLog>();
+
+		public void onMessage(ApplicationLog log) {
+			logs.add(log);
+		}
+
+		public void onError(Throwable exception) {
+			synchronized (this) {
+				this.notify();
+			}
+		}
+
+		public void onComplete() {
+			synchronized (this) {
+				this.notify();
+			}
+		}
+
+		public List<ApplicationLog> getLogs() {
+			Collections.sort(logs);
+			return logs;
+		}
+	}
+
 	private Map<String, Object> findApplicationResource(UUID appGuid, boolean fetchServiceInfo) {
 		Map<String, Object> urlVars = new HashMap<String, Object>();
 		String urlPath = "/v2/apps/{app}?inline-relations-depth=1";