gh-204 Introduce putMetadata() and setMetadata() function to ServiceInstance

spring-cloud-commons/src/main/java/org/springframework/cloud/client/DefaultServiceInstance.java

@@ -16,16 +16,17 @@
 
 package org.springframework.cloud.client;
 
-
 import java.net.URI;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Set;
 
 /**
  * Default implementation of {@link ServiceInstance}.
  *
  * @author Spencer Gibb
+ * @author Steven van Beelen
  */
 public class DefaultServiceInstance implements ServiceInstance {
 
@@ -48,24 +49,61 @@ public DefaultServiceInstance(String serviceId, String host, int port, boolean s
 		this.metadata = metadata;
 	}
 
-	public DefaultServiceInstance(String serviceId, String host, int port,
-			boolean secure) {
-		this(serviceId, host, port, secure, new LinkedHashMap<String, String>());
+	public DefaultServiceInstance(String serviceId, String host, int port, boolean secure) {
+		this(serviceId, host, port, secure, new LinkedHashMap<>());
 	}
 
-	@Override
-	public URI getUri() {
-		return getUri(this);
-	}
+    @Override
+    public String getServiceId() {
+        return serviceId;
+    }
+
+    @Override
+    public String getHost() {
+        return host;
+    }
+
+    @Override
+    public int getPort() {
+        return port;
+    }
+
+    @Override
+    public boolean isSecure() {
+        return secure;
+    }
 
 	@Override
 	public Map<String, String> getMetadata() {
 		return this.metadata;
 	}
 
+	@Override
+	public void putMetadata(String key, String value) {
+		this.metadata.put(key, value);
+	}
+
+	@Override
+	public void setMetadata(Map<String, String> metadata) {
+		Set<String> keySet = this.metadata.keySet();
+		for (String key : keySet) {
+			this.metadata.remove(key);
+		}
+
+		for (Map.Entry<String, String> newEntry : metadata.entrySet()) {
+			this.metadata.put(newEntry.getKey(), newEntry.getValue());
+		}
+	}
+
+    @Override
+    public URI getUri() {
+        return getUri(this);
+    }
+
 	/**
 	 * Create a uri from the given ServiceInstance's host:port
-	 * @param instance
+     *
+	 * @param instance a {@link ServiceInstance} to create an {@link java.net.URI} out of.
 	 * @return URI of the form (secure)?https:http + "host:port"
 	 */
 	public static URI getUri(ServiceInstance instance) {
@@ -75,26 +113,6 @@ public static URI getUri(ServiceInstance instance) {
 		return URI.create(uri);
 	}
 
-	@Override
-	public String getServiceId() {
-		return serviceId;
-	}
-
-	@Override
-	public String getHost() {
-		return host;
-	}
-
-	@Override
-	public int getPort() {
-		return port;
-	}
-
-	@Override
-	public boolean isSecure() {
-		return secure;
-	}
-
 	@Override
 	public String toString() {
 		return "DefaultServiceInstance{" +

spring-cloud-commons/src/main/java/org/springframework/cloud/client/ServiceInstance.java

@@ -21,7 +21,9 @@
 
 /**
  * Represents an instance of a Service in a Discovery System
+ *
  * @author Spencer Gibb
+ * @author Steven van Beelen
  */
 public interface ServiceInstance {
 
@@ -54,4 +56,22 @@ public interface ServiceInstance {
 	 * @return the key value pair metadata associated with the service instance
 	 */
 	Map<String, String> getMetadata();
+
+	/**
+	 * Add a key/value pair to the metadata map.
+     *
+	 * @param key   a metadata key as a String
+	 * @param value a corresponding metadata value as a String
+	 */
+	default void putMetadata(String key, String value) {
+	}
+
+	/**
+	 * Replace the current metadata map for a new one.
+     *
+	 * @param metadata a metadata map to replace the current metadata
+	 */
+	default void setMetadata(Map<String, String> metadata) {
+	}
+
 }

spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/simple/SimpleDiscoveryProperties.java

@@ -122,5 +122,16 @@ public URI getUri() {
 		public Map<String, String> getMetadata() {
 			return this.metadata;
 		}
+
+		@Override
+		public void putMetadata(String key, String value) {
+			this.metadata.put(key, value);
+		}
+
+		@Override
+		public void setMetadata(Map<String, String> metadata) {
+			this.metadata = metadata;
+		}
+
 	}
 }