#94 Encoding "+" in a resource path; had to change some plumbing to construct a URI instance

rjrudin · rjrudin · commit 5eb02cc77131 · 2016-04-17T22:12:52.000-04:00
diff --git a/src/main/java/com/marklogic/appdeployer/command/restapis/DeployRestApiServersCommand.java b/src/main/java/com/marklogic/appdeployer/command/restapis/DeployRestApiServersCommand.java
@@ -147,15 +147,15 @@ protected String getDefaultRestApiPayload() {
     protected boolean deleteRestApi(String serverName, String groupName, ManageClient manageClient,
             boolean includeModules, boolean includeContent) {
         if (new ServerManager(manageClient, groupName).exists(serverName)) {
-            String path = format("%s/v1/rest-apis/%s?", manageClient.getBaseUrl(), serverName);
+            String path = format("/v1/rest-apis/%s?", serverName);
             if (includeModules) {
                 path += "include=modules&";
             }
             if (includeContent) {
                 path += "include=content";
             }
             logger.info("Deleting REST API, path: " + path);
-            manageClient.getRestTemplate().exchange(path, HttpMethod.DELETE, null, String.class);
+            manageClient.getRestTemplate().exchange(manageClient.buildUri(path), HttpMethod.DELETE, null, String.class);
             logger.info("Deleted REST API");
             return true;
         } else {
diff --git a/src/main/java/com/marklogic/mgmt/AbstractResourceManager.java b/src/main/java/com/marklogic/mgmt/AbstractResourceManager.java
@@ -24,6 +24,7 @@ public String getResourcesPath() {
     }
 
     public String getResourcePath(String resourceNameOrId, String... resourceUrlParams) {
+        resourceNameOrId = encodeResourceId(resourceNameOrId);
         return appendParamsAndValuesToPath(format("%s/%s", getResourcesPath(), resourceNameOrId), resourceUrlParams);
     }
 
@@ -40,8 +41,8 @@ public boolean exists(String resourceNameOrId, String... resourceUrlParams) {
     }
 
     public ResourcesFragment getAsXml() {
-        Fragment f = useAdminUser() ? manageClient.getXmlAsAdmin(getResourcesPath()) : manageClient
-                .getXml(getResourcesPath());
+        Fragment f = useAdminUser() ? manageClient.getXmlAsAdmin(getResourcesPath())
+                : manageClient.getXml(getResourcesPath());
         return new ResourcesFragment(f);
     }
 
@@ -83,6 +84,19 @@ public SaveReceipt save(String payload) {
         return new SaveReceipt(resourceId, payload, path, response);
     }
 
+    /**
+     * Mimetypes are likely to have a "+" in them, which the Management REST API won't support in a path - it needs to
+     * be encoded. Other resources could have a "+" in their ID value as well. However, doing a full encoding doesn't
+     * seem to be a great idea, as that will e.g. encode a forward slash in a mimetype as well, which will result in a
+     * 404.
+     * 
+     * @param idValue
+     * @return
+     */
+    protected String encodeResourceId(String idValue) {
+        return idValue != null ? idValue.replace("+", "%2B") : idValue;
+    }
+
     /**
      * Most clients should just use the save method, but this is public for scenarios where a client knows an update
      * should be performed.
@@ -115,8 +129,8 @@ public DeleteReceipt deleteByIdField(String resourceIdFieldValue, String... reso
     public DeleteReceipt delete(String payload, String... resourceUrlParams) {
         String resourceId = getResourceId(payload);
         if (!exists(resourceId)) {
-            logger.info(format("Could not find %s with name or ID of %s, so not deleting", getResourceName(),
-                    resourceId));
+            logger.info(
+                    format("Could not find %s with name or ID of %s, so not deleting", getResourceName(), resourceId));
             return new DeleteReceipt(resourceId, null, false);
         } else {
             String path = getResourcePath(resourceId, resourceUrlParams);
diff --git a/src/main/java/com/marklogic/mgmt/ManageClient.java b/src/main/java/com/marklogic/mgmt/ManageClient.java
@@ -1,5 +1,6 @@
 package com.marklogic.mgmt;
 
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -26,7 +27,6 @@ public class ManageClient extends LoggingObject {
     private ManageConfig manageConfig;
     private RestTemplate restTemplate;
     private RestTemplate adminRestTemplate;
-    private String baseUrl;
 
     /**
      * Can use this constructor when the default values in ManageConfig will work.
@@ -55,51 +55,46 @@ public void initialize(ManageConfig config) {
         } else {
             this.adminRestTemplate = restTemplate;
         }
-
-        this.baseUrl = config.getBaseUrl();
-        if (logger.isInfoEnabled()) {
-            logger.info("Initialized ManageClient with base URL of: " + baseUrl);
-        }
     }
 
     public ResponseEntity<String> putJson(String path, String json) {
         logRequest(path, "JSON", "PUT");
-        return restTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildJsonEntity(json), String.class);
+        return restTemplate.exchange(buildUri(path), HttpMethod.PUT, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> putJsonAsAdmin(String path, String json) {
         logAdminRequest(path, "JSON", "PUT");
-        return adminRestTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildJsonEntity(json), String.class);
+        return adminRestTemplate.exchange(buildUri(path), HttpMethod.PUT, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> putXml(String path, String xml) {
         logRequest(path, "XML", "PUT");
-        return restTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildXmlEntity(xml), String.class);
+        return restTemplate.exchange(buildUri(path), HttpMethod.PUT, buildXmlEntity(xml), String.class);
     }
 
     public ResponseEntity<String> putXmlAsAdmin(String path, String xml) {
         logAdminRequest(path, "XML", "PUT");
-        return adminRestTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildXmlEntity(xml), String.class);
+        return adminRestTemplate.exchange(buildUri(path), HttpMethod.PUT, buildXmlEntity(xml), String.class);
     }
 
     public ResponseEntity<String> postJson(String path, String json) {
         logRequest(path, "JSON", "POST");
-        return restTemplate.exchange(baseUrl + path, HttpMethod.POST, buildJsonEntity(json), String.class);
+        return restTemplate.exchange(buildUri(path), HttpMethod.POST, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> postJsonAsAdmin(String path, String json) {
         logAdminRequest(path, "JSON", "POST");
-        return adminRestTemplate.exchange(baseUrl + path, HttpMethod.POST, buildJsonEntity(json), String.class);
+        return adminRestTemplate.exchange(buildUri(path), HttpMethod.POST, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> postXml(String path, String xml) {
         logRequest(path, "XML", "POST");
-        return restTemplate.exchange(baseUrl + path, HttpMethod.POST, buildXmlEntity(xml), String.class);
+        return restTemplate.exchange(buildUri(path), HttpMethod.POST, buildXmlEntity(xml), String.class);
     }
 
     public ResponseEntity<String> postXmlAsAdmin(String path, String xml) {
         logAdminRequest(path, "XML", "POST");
-        return adminRestTemplate.exchange(baseUrl + path, HttpMethod.POST, buildXmlEntity(xml), String.class);
+        return adminRestTemplate.exchange(buildUri(path), HttpMethod.POST, buildXmlEntity(xml), String.class);
     }
 
     public ResponseEntity<String> postForm(String path, String... params) {
@@ -111,12 +106,12 @@ public ResponseEntity<String> postForm(String path, String... params) {
             map.add(params[i], params[i + 1]);
         }
         HttpEntity<MultiValueMap<String, String>> entity = new HttpEntity<MultiValueMap<String, String>>(map, headers);
-        return restTemplate.exchange(baseUrl + path, HttpMethod.POST, entity, String.class);
+        return restTemplate.exchange(buildUri(path), HttpMethod.POST, entity, String.class);
     }
 
     public Fragment getXml(String path, String... namespacePrefixesAndUris) {
         logRequest(path, "XML", "GET");
-        String xml = getRestTemplate().getForObject(getBaseUrl() + path, String.class);
+        String xml = getRestTemplate().getForObject(buildUri(path), String.class);
         List<Namespace> list = new ArrayList<Namespace>();
         for (int i = 0; i < namespacePrefixesAndUris.length; i += 2) {
             list.add(Namespace.getNamespace(namespacePrefixesAndUris[i], namespacePrefixesAndUris[i + 1]));
@@ -126,7 +121,7 @@ public Fragment getXml(String path, String... namespacePrefixesAndUris) {
 
     public Fragment getXmlAsAdmin(String path, String... namespacePrefixesAndUris) {
         logAdminRequest(path, "XML", "GET");
-        String xml = getAdminRestTemplate().getForObject(getBaseUrl() + path, String.class);
+        String xml = getAdminRestTemplate().getForObject(buildUri(path), String.class);
         List<Namespace> list = new ArrayList<Namespace>();
         for (int i = 0; i < namespacePrefixesAndUris.length; i += 2) {
             list.add(Namespace.getNamespace(namespacePrefixesAndUris[i], namespacePrefixesAndUris[i + 1]));
@@ -138,18 +133,25 @@ public String getJson(String path) {
         logRequest(path, "JSON", "GET");
         HttpHeaders headers = new HttpHeaders();
         headers.set("Accept", MediaType.APPLICATION_JSON_VALUE);
-        return getRestTemplate().exchange(getBaseUrl() + path, HttpMethod.GET, new HttpEntity<>(headers), String.class)
+        return getRestTemplate().exchange(buildUri(path), HttpMethod.GET, new HttpEntity<>(headers), String.class)
                 .getBody();
     }
 
+    public String getJson(URI uri) {
+        logRequest(uri.toString(), "JSON", "GET");
+        HttpHeaders headers = new HttpHeaders();
+        headers.set("Accept", MediaType.APPLICATION_JSON_VALUE);
+        return getRestTemplate().exchange(uri, HttpMethod.GET, new HttpEntity<>(headers), String.class).getBody();
+    }
+
     public void delete(String path) {
         logRequest(path, "", "DELETE");
-        restTemplate.delete(baseUrl + path);
+        restTemplate.delete(buildUri(path));
     }
 
     public void deleteAsAdmin(String path) {
         logAdminRequest(path, "", "DELETE");
-        adminRestTemplate.delete(baseUrl + path);
+        adminRestTemplate.delete(buildUri(path));
     }
 
     public HttpEntity<String> buildJsonEntity(String json) {
@@ -178,12 +180,12 @@ protected void logAdminRequest(String path, String contentType, String method) {
         }
     }
 
-    public RestTemplate getRestTemplate() {
-        return restTemplate;
+    public URI buildUri(String path) {
+        return manageConfig.buildUri(path);
     }
 
-    public String getBaseUrl() {
-        return baseUrl;
+    public RestTemplate getRestTemplate() {
+        return restTemplate;
     }
 
     public RestTemplate getAdminRestTemplate() {
diff --git a/src/main/java/com/marklogic/mgmt/admin/AdminManager.java b/src/main/java/com/marklogic/mgmt/admin/AdminManager.java
@@ -1,5 +1,7 @@
 package com.marklogic.mgmt.admin;
 
+import java.net.URI;
+
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
@@ -39,7 +41,7 @@ public void init() {
     }
 
     public void init(String licenseKey, String licensee) {
-        final String url = adminConfig.getBaseUrl() + "/admin/v1/init";
+        final URI uri = adminConfig.buildUri("/admin/v1/init");
 
         String json = null;
         if (licenseKey != null && licensee != null) {
@@ -49,15 +51,15 @@ public void init(String licenseKey, String licensee) {
         }
         final String payload = json;
 
-        logger.info("Initializing MarkLogic at: " + url);
+        logger.info("Initializing MarkLogic at: " + uri);
         invokeActionRequiringRestart(new ActionRequiringRestart() {
             @Override
             public boolean execute() {
                 HttpHeaders headers = new HttpHeaders();
                 headers.setContentType(MediaType.APPLICATION_JSON);
                 HttpEntity<String> entity = new HttpEntity<String>(payload, headers);
                 try {
-                    ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.POST, entity, String.class);
+                    ResponseEntity<String> response = restTemplate.exchange(uri, HttpMethod.POST, entity, String.class);
                     logger.info("Initialization response: " + response);
                     // According to http://docs.marklogic.com/REST/POST/admin/v1/init, a 202 is sent back in the event a
                     // restart is needed. A 400 or 401 will be thrown as an error by RestTemplate.
@@ -84,7 +86,7 @@ public void installAdmin() {
     }
 
     public void installAdmin(String username, String password) {
-        final String url = adminConfig.getBaseUrl() + "/admin/v1/instance-admin";
+        final URI uri = adminConfig.buildUri("/admin/v1/instance-admin");
 
         String json = null;
         if (username != null && password != null) {
@@ -95,15 +97,15 @@ public void installAdmin(String username, String password) {
         }
         final String payload = json;
 
-        logger.info("Installing admin user at: " + url);
+        logger.info("Installing admin user at: " + uri);
         invokeActionRequiringRestart(new ActionRequiringRestart() {
             @Override
             public boolean execute() {
                 HttpHeaders headers = new HttpHeaders();
                 headers.setContentType(MediaType.APPLICATION_JSON);
                 HttpEntity<String> entity = new HttpEntity<String>(payload, headers);
                 try {
-                    ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.POST, entity, String.class);
+                    ResponseEntity<String> response = restTemplate.exchange(uri, HttpMethod.POST, entity, String.class);
                     logger.info("Admin installation response: " + response);
                     // According to http://docs.marklogic.com/REST/POST/admin/v1/init, a 202 is sent back in the event a
                     // restart is needed. A 400 or 401 will be thrown as an error by RestTemplate.
@@ -137,7 +139,7 @@ public void invokeActionRequiringRestart(ActionRequiringRestart action) {
     }
 
     public String getLastRestartTimestamp() {
-        return restTemplate.getForEntity(adminConfig.getBaseUrl() + "/admin/v1/timestamp", String.class).getBody();
+        return restTemplate.getForEntity(adminConfig.buildUri("/admin/v1/timestamp"), String.class).getBody();
     }
 
     public void waitForRestart() {
@@ -199,13 +201,13 @@ public boolean execute() {
     }
 
     public Fragment getServerConfig() {
-        return new Fragment(restTemplate.getForObject(adminConfig.getBaseUrl() + "/admin/v1/server-config", String.class));
+        return new Fragment(restTemplate.getForObject(adminConfig.buildUri("/admin/v1/server-config"), String.class));
     }
-    
+
     public String getServerVersion() {
         return getServerConfig().getElementValue("/m:host/m:version");
     }
-    
+
     public void setWaitForRestartCheckInterval(int waitForRestartCheckInterval) {
         this.waitForRestartCheckInterval = waitForRestartCheckInterval;
     }
diff --git a/src/main/java/com/marklogic/mgmt/security/CertificateAuthorityManager.java b/src/main/java/com/marklogic/mgmt/security/CertificateAuthorityManager.java
@@ -25,15 +25,15 @@ public ResponseEntity<String> create(String payload) {
         headers.setContentType(MediaType.TEXT_PLAIN);
 
         HttpEntity<String> entity = new HttpEntity<String>(payload, headers);
-        ResponseEntity<String> response = t.exchange(manageClient.getBaseUrl() + "/manage/v2/certificate-authorities",
+        ResponseEntity<String> response = t.exchange(manageClient.buildUri("/manage/v2/certificate-authorities"),
                 HttpMethod.POST, entity, String.class);
         return response;
     }
 
     public ResourcesFragment getAsXml() {
         return new ResourcesFragment(manageClient.getXml("/manage/v2/certificate-authorities"));
     }
-    
+
     public void delete(String resourceIdOrName) {
         manageClient.delete("/manage/v2/certificate-authorities/" + resourceIdOrName);
     }
diff --git a/src/main/java/com/marklogic/rest/util/RestConfig.java b/src/main/java/com/marklogic/rest/util/RestConfig.java
@@ -1,11 +1,15 @@
 package com.marklogic.rest.util;
 
+import java.net.URI;
+import java.net.URISyntaxException;
+
 public class RestConfig {
 
     private String host;
     private int port;
     private String username;
     private String password;
+    private String scheme = "http";
 
     public RestConfig() {
     }
@@ -19,11 +23,27 @@ public RestConfig(String host, int port, String username, String password) {
 
     @Override
     public String toString() {
-        return String.format("[host: %s, port: %d, username: %s]", host, port, username);
+        return String.format("[scheme: %s, host: %s, port: %d, username: %s]", scheme, host, port, username);
+    }
+
+    /**
+     * Using the java.net.URI constructor that takes a string. Using any other constructor runs into encoding problems,
+     * e.g. when a mimetype has a plus in it, that plus needs to be encoded, but doing as %2B will result in the % being
+     * double encoded.
+     * 
+     * @param path
+     * @return
+     */
+    public URI buildUri(String path) {
+        try {
+            return new URI(String.format("%s://%s:%d%s", getScheme(), getHost(), getPort(), path));
+        } catch (URISyntaxException ex) {
+            throw new RuntimeException("Unable to build URI for path: " + path + "; cause: " + ex.getMessage(), ex);
+        }
     }
 
     public String getBaseUrl() {
-        return String.format("http://%s:%d", host, port);
+        return String.format("%s://%s:%d", scheme, host, port);
     }
 
     public String getHost() {
@@ -57,4 +77,12 @@ public String getPassword() {
     public void setPassword(String password) {
         this.password = password;
     }
+
+    public String getScheme() {
+        return scheme;
+    }
+
+    public void setScheme(String scheme) {
+        this.scheme = scheme;
+    }
 }
diff --git a/src/test/java/com/marklogic/appdeployer/command/mimetypes/ManageMimetypesTest.java b/src/test/java/com/marklogic/appdeployer/command/mimetypes/ManageMimetypesTest.java
@@ -19,7 +19,7 @@ protected Command newCommand() {
 
     @Override
     protected String[] getResourceNames() {
-        return new String[] { "text/gradle" };
+        return new String[] { "application/ditamap+xml" };
     }
 
 }
diff --git a/src/test/resources/db.json b/src/test/resources/db.json
diff --git a/src/test/resources/sample-app/src/main/ml-config/mimetypes/ditamap.json b/src/test/resources/sample-app/src/main/ml-config/mimetypes/ditamap.json
diff --git a/src/test/resources/sample-app/src/main/ml-config/mimetypes/gradle.json b/src/test/resources/sample-app/src/main/ml-config/mimetypes/gradle.json

Original file line number	Diff line number	Diff line change
`@@ -25,15 +25,15 @@ public ResponseEntity<String> create(String payload) {`
`25`	`25`	`headers.setContentType(MediaType.TEXT_PLAIN);`
`26`	`26`
`27`	`27`	`HttpEntity<String> entity = new HttpEntity<String>(payload, headers);`
`28`		`- ResponseEntity<String> response = t.exchange(manageClient.getBaseUrl() + "/manage/v2/certificate-authorities",`
	`28`	`+ ResponseEntity<String> response = t.exchange(manageClient.buildUri("/manage/v2/certificate-authorities"),`
`29`	`29`	`HttpMethod.POST, entity, String.class);`
`30`	`30`	`return response;`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public ResourcesFragment getAsXml() {`
`34`	`34`	`return new ResourcesFragment(manageClient.getXml("/manage/v2/certificate-authorities"));`
`35`	`35`	`}`
`36`		`-`
	`36`	`+`
`37`	`37`	`public void delete(String resourceIdOrName) {`
`38`	`38`	`manageClient.delete("/manage/v2/certificate-authorities/" + resourceIdOrName);`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ protected Command newCommand() {`
`19`	`19`
`20`	`20`	`@Override`
`21`	`21`	`protected String[] getResourceNames() {`
`22`		`- return new String[] { "text/gradle" };`
	`22`	`+ return new String[] { "application/ditamap+xml" };`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`}`