#451 Protected collection names are now URL encoded

Author: rjrudin

src/main/java/com/marklogic/mgmt/resource/rebalancer/PartitionManager.java

@@ -46,7 +46,6 @@ public ResponseEntity<String> takePartitionOffline(String partitionName) {
 
 	public PartitionProperties getPartitionProperties(String partitionName) {
 		JsonNode json = getManageClient().getJsonNode(getPropertiesPath(partitionName));
-		System.out.println("JSON: " + json);
 		if (json != null && json.has("partition-properties")) {
 			JsonNode props = json.get("partition-properties");
 			try {

src/main/java/com/marklogic/mgmt/resource/security/ProtectedCollectionsManager.java

@@ -3,6 +3,9 @@
 import com.marklogic.mgmt.resource.AbstractResourceManager;
 import com.marklogic.mgmt.ManageClient;
 
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+
 public class ProtectedCollectionsManager extends AbstractResourceManager {
 
     public ProtectedCollectionsManager(ManageClient client) {
@@ -26,12 +29,28 @@ protected String getIdFieldName() {
 
     @Override
     public String getPropertiesPath(String resourceNameOrId, String... resourceUrlParams) {
-        return getResourcesPath() + "/properties?collection=" + resourceNameOrId;
+        return getResourcesPath() + "/properties?collection=" + encodeCollectionName(resourceNameOrId);
     }
 
     @Override
     public String getResourcePath(String resourceNameOrId, String... resourceUrlParams) {
-        return getResourcesPath() + "?collection=" + resourceNameOrId;
+        return getResourcesPath() + "?collection=" + encodeCollectionName(resourceNameOrId);
     }
 
+	/**
+	 * For most Manage API resources, MarkLogic prohibits characters that require URL encoding. Collection names are
+	 * an exception though and thus require URL encoding so that their names can be used in a querystring.
+	 *
+	 * @param collectionName
+	 * @return
+	 */
+	private String encodeCollectionName(String collectionName) {
+		try {
+			return URLEncoder.encode(collectionName, "utf-8");
+		} catch (UnsupportedEncodingException e) {
+			logger.warn(format("Unable to encode collection: %s; will include un-encoded collection name in " +
+				"querystring; cause: %s", collectionName, e.getMessage()));
+			return collectionName;
+		}
+	}
 }

src/test/java/com/marklogic/appdeployer/command/security/ManageProtectedCollectionsTest.java

@@ -7,19 +7,19 @@
 
 public class ManageProtectedCollectionsTest extends AbstractManageResourceTest {
 
-    @Override
-    protected ResourceManager newResourceManager() {
-        return new ProtectedCollectionsManager(manageClient);
-    }
+	@Override
+	protected ResourceManager newResourceManager() {
+		return new ProtectedCollectionsManager(manageClient);
+	}
 
-    @Override
-    protected Command newCommand() {
-        return new DeployProtectedCollectionsCommand();
-    }
+	@Override
+	protected Command newCommand() {
+		return new DeployProtectedCollectionsCommand();
+	}
 
-    @Override
-    protected String[] getResourceNames() {
-        return new String[] { "sample-app-collection", "http://example.org" };
-    }
+	@Override
+	protected String[] getResourceNames() {
+		return new String[]{"sample-app-collection#stuff", "http://example.org"};
+	}
 
 }

src/test/resources/sample-app/src/main/ml-config/security/protected-collections/collection-1.json

@@ -1,5 +1,5 @@
 {
-  "collection": "sample-app-collection",
+  "collection": "sample-app-collection#stuff",
   "permission": [
     {
       "role-name": "view-admin",