Merge pull request Netflix#272 from krutsko/ISSUE_218

ISSUE-218 Makes converter replacement char configurable thru config.
is00hcw · Dec 2, 2014 · a70a060 · a70a060
2 parents 671263c + dd09a96
commit a70a060
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 5 deletions.
diff --git a/eureka-client/src/main/java/com/netflix/discovery/DefaultEurekaClientConfig.java b/eureka-client/src/main/java/com/netflix/discovery/DefaultEurekaClientConfig.java
@@ -468,4 +468,16 @@ public int getCacheRefreshExecutorExponentialBackOffBound() {
         return configInstance.getIntProperty(
                 namespace + "client.cacheRefresh.exponentialBackOffBound", 10).get();
     }
+
+    @Override
+    public String getDollarReplacement() {
+        return configInstance.getStringProperty(
+                namespace + "dollarReplacement", "_-").get();
+    }
+
+    @Override
+    public String getEscapeCharReplacement() {
+        return configInstance.getStringProperty(
+                namespace + "escapeCharReplacement", "__").get();
+    }
 }
diff --git a/eureka-client/src/main/java/com/netflix/discovery/EurekaClientConfig.java b/eureka-client/src/main/java/com/netflix/discovery/EurekaClientConfig.java
@@ -475,4 +475,18 @@ public interface EurekaClientConfig {
      * @return maximum multiplier value for retry delay
      */
     int getCacheRefreshExecutorExponentialBackOffBound();
+
+    /**
+     * Get a replacement string for Dollar sign <code>$</code> during serializing/deserializing information in eureka server.
+     *
+     * @return Replacement string for Dollar sign <code>$</code>.
+     */
+    String getDollarReplacement();
+
+    /**
+     * Get a replacement string for underscore sign <code>_</code> during serializing/deserializing information in eureka server.
+     *
+     * @return Replacement string for underscore sign <code>_</code>.
+     */
+    String getEscapeCharReplacement();
 }
diff --git a/eureka-client/src/main/java/com/netflix/discovery/converters/JsonXStream.java b/eureka-client/src/main/java/com/netflix/discovery/converters/JsonXStream.java
@@ -17,6 +17,8 @@
 package com.netflix.discovery.converters;
 
 import com.netflix.appinfo.InstanceInfo;
+import com.netflix.discovery.DiscoveryManager;
+import com.netflix.discovery.EurekaClientConfig;
 import com.netflix.discovery.shared.Application;
 import com.netflix.discovery.shared.Applications;
 import com.thoughtworks.xstream.XStream;
@@ -41,7 +43,7 @@ public class JsonXStream extends XStream {
 
     public JsonXStream() {
         super(new JettisonMappedXmlDriver() {
-            private final NameCoder coder = new XmlFriendlyNameCoder();
+            private final NameCoder coder = initializeNameCoder();
 
             protected NameCoder getNameCoder() {
                 return this.coder;
@@ -60,4 +62,10 @@ protected NameCoder getNameCoder() {
     public static JsonXStream getInstance() {
         return s_instance;
     }
+
+    private static XmlFriendlyNameCoder initializeNameCoder(){
+        EurekaClientConfig clientConfig = DiscoveryManager
+                .getInstance().getEurekaClientConfig();
+        return new XmlFriendlyNameCoder(clientConfig.getDollarReplacement(), clientConfig.getEscapeCharReplacement());
+    }
 }
diff --git a/eureka-client/src/main/java/com/netflix/discovery/converters/XmlXStream.java b/eureka-client/src/main/java/com/netflix/discovery/converters/XmlXStream.java
@@ -17,10 +17,13 @@
 package com.netflix.discovery.converters;
 
 import com.netflix.appinfo.InstanceInfo;
+import com.netflix.discovery.DiscoveryManager;
+import com.netflix.discovery.EurekaClientConfig;
 import com.netflix.discovery.shared.Application;
 import com.netflix.discovery.shared.Applications;
 import com.thoughtworks.xstream.XStream;
 import com.thoughtworks.xstream.io.xml.DomDriver;
+import com.thoughtworks.xstream.io.xml.XmlFriendlyNameCoder;
 
 /**
  * An <tt>Xstream</tt> specific implementation for serializing and deserializing
@@ -39,7 +42,7 @@ public class XmlXStream extends XStream {
     private static final XmlXStream s_instance = new XmlXStream();
 
     public XmlXStream() {
-        super(new DomDriver());
+        super(new DomDriver(null, initializeNameCoder()));
 
         registerConverter(new Converters.ApplicationConverter());
         registerConverter(new Converters.ApplicationsConverter());
@@ -55,4 +58,10 @@ public XmlXStream() {
     public static XmlXStream getInstance() {
         return s_instance;
     }
+
+    private static XmlFriendlyNameCoder initializeNameCoder(){
+        EurekaClientConfig clientConfig = DiscoveryManager
+                .getInstance().getEurekaClientConfig();
+        return new XmlFriendlyNameCoder(clientConfig.getDollarReplacement(), clientConfig.getEscapeCharReplacement());
+    }
 }
diff --git a/eureka-client/src/test/java/com/netflix/discovery/AbstractDiscoveryClientTester.java b/eureka-client/src/test/java/com/netflix/discovery/AbstractDiscoveryClientTester.java
@@ -79,8 +79,10 @@ protected void setupDiscoveryClient() {
 
     protected void setupDiscoveryClient(int renewalIntervalInSecs) {
         InstanceInfo.Builder builder = newInstanceInfoBuilder(renewalIntervalInSecs);
-        client = new DiscoveryClient(builder.build(), new DefaultEurekaClientConfig());
-
+        DefaultEurekaClientConfig config = new DefaultEurekaClientConfig();
+        // setup config in advance, used in initialize converter
+        DiscoveryManager.getInstance().setEurekaClientConfig(config);
+        client = new DiscoveryClient(builder.build(), config);
         ApplicationInfoManager.getInstance().initComponent(new MyDataCenterInstanceConfig());
     }
 

diff --git a/eureka-core/src/test/java/com/netflix/eureka/AbstractTester.java b/eureka-core/src/test/java/com/netflix/eureka/AbstractTester.java
@@ -10,6 +10,7 @@
 import com.netflix.config.ConfigurationManager;
 import com.netflix.discovery.DefaultEurekaClientConfig;
 import com.netflix.discovery.DiscoveryClient;
+import com.netflix.discovery.DiscoveryManager;
 import com.netflix.discovery.shared.Application;
 import com.netflix.discovery.shared.Pair;
 import com.netflix.eureka.mock.MockRemoteEurekaServer;
@@ -81,7 +82,10 @@ public Name getName() {
                                                              "http://localhost:" + mockRemoteEurekaServer.getPort() +
                                                              MockRemoteEurekaServer.EUREKA_API_BASE_PATH);
 
-        client = new DiscoveryClient(builder.build(), new DefaultEurekaClientConfig());
+        DefaultEurekaClientConfig config = new DefaultEurekaClientConfig();
+        // setup config in advance, used in initialize converter
+        DiscoveryManager.getInstance().setEurekaClientConfig(config);
+        client = new DiscoveryClient(builder.build(), config);
         ApplicationInfoManager.getInstance().initComponent(new MyDataCenterInstanceConfig());
         registry = new PeerAwareInstanceRegistry() {