#174 Handling role with permission referring to itself

Author: rjrudin

src/main/java/com/marklogic/appdeployer/command/AbstractCommand.java

@@ -116,7 +116,7 @@ protected SaveReceipt saveResource(ResourceManager mgr, CommandContext context,
      * @param context
      */
     protected void storeTokenForResourceId(SaveReceipt receipt, CommandContext context) {
-        URI location = receipt.getResponse().getHeaders().getLocation();
+        URI location = receipt.getResponse() != null ? receipt.getResponse().getHeaders().getLocation() : null;
 
         String idValue = null;
         String resourceName = null;

src/main/java/com/marklogic/mgmt/AbstractResourceManager.java

@@ -4,6 +4,8 @@
 import com.marklogic.rest.util.ResourcesFragment;
 import org.springframework.http.ResponseEntity;
 
+import javax.xml.ws.Response;
+
 /**
  * This class makes a number of assumptions in order to simplify the implementation of common operations for a MarkLogic
  * management resource. Feel free to override the methods in here in a subclass when those assumptions don't work for a
@@ -75,30 +77,41 @@ public String getPropertiesAsJson(String resourceNameOrId, String... resourceUrl
      */
     public SaveReceipt save(String payload) {
         String resourceId = getResourceId(payload);
-        String label = getResourceName();
-        String path = null;
-        ResponseEntity<String> response = null;
         if (exists(resourceId)) {
             if (updateAllowed) {
                 return updateResource(payload, resourceId);
             } else {
                 logger.info("Resource already exists and updates are not supported, so not updating: " + resourceId);
+	            /**
+	             * Prior to version 2.9.0, this was always returning a non-null SaveReceipt with a null path and null
+	             * response. Not sure of the consequences of returning null instead, so keeping this behavior for now.
+	             */
+	            return new SaveReceipt(resourceId, payload, null, null);
             }
         } else {
-            logger.info(format("Creating %s: %s", label, resourceId));
-            path = getCreateResourcePath(payload);
-            response = postPayload(manageClient, path, payload);
-            logger.info(format("Created %s: %s", label, resourceId));
+        	return createNewResource(payload, resourceId);
         }
-        return new SaveReceipt(resourceId, payload, path, response);
+    }
+
+    protected SaveReceipt createNewResource(String payload, String resourceId) {
+    	String label = getResourceName();
+    	if (logger.isInfoEnabled()) {
+		    logger.info(format("Creating %s: %s", label, resourceId));
+	    }
+	    String path = getCreateResourcePath(payload);
+	    ResponseEntity<String> response = postPayload(manageClient, path, payload);
+	    if (logger.isInfoEnabled()) {
+		    logger.info(format("Created %s: %s", label, resourceId));
+	    }
+	    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
      */
@@ -109,7 +122,7 @@ protected String encodeResourceId(String idValue) {
     /**
      * Most clients should just use the save method, but this is public for scenarios where a client knows an update
      * should be performed.
-     * 
+     *
      * @param payload
      * @param resourceId
      * @return
@@ -159,7 +172,7 @@ protected void beforeDelete(String resourceId, String path, String... resourceUr
 
     /**
      * Convenience method for performing a delete once the correct path for the resource has been constructed.
-     * 
+     *
      * @param path
      */
     public void deleteAtPath(String path) {
@@ -175,7 +188,7 @@ public void deleteAtPath(String path) {
 
     /**
      * TODO Could use something nicer here, particularly to properly encode the parameter values.
-     * 
+     *
      * @param path
      * @param paramsAndValues
      * @return
@@ -203,7 +216,7 @@ protected String appendParamsAndValuesToPath(String path, String... paramsAndVal
 
     /**
      * Can be overridden by subclass to provide custom querystring parameters.
-     * 
+     *
      * @param payload
      *            XML or JSON payload
      * @return
@@ -214,7 +227,7 @@ protected String[] getUpdateResourceParams(String payload) {
 
     /**
      * Defaults to the "update" resource parameters.
-     * 
+     *
      * @param payload
      *            XML or JSON payload
      * @return

src/main/java/com/marklogic/mgmt/api/API.java

@@ -74,11 +74,13 @@ public API(ManageClient client, ObjectMapper mapper) {
     }
 
     protected void initializeAdminManager() {
-        ManageConfig mc = manageClient.getManageConfig();
-        if (mc.getAdminUsername() != null && mc.getAdminPassword() != null) {
-            AdminConfig ac = new AdminConfig(mc.getHost(), 8001, mc.getAdminUsername(), mc.getAdminPassword());
-            this.adminManager = new AdminManager(ac);
-        }
+    	if (manageClient != null) {
+		    ManageConfig mc = manageClient.getManageConfig();
+		    if (mc.getAdminUsername() != null && mc.getAdminPassword() != null) {
+			    AdminConfig ac = new AdminConfig(mc.getHost(), 8001, mc.getAdminUsername(), mc.getAdminPassword());
+			    this.adminManager = new AdminManager(ac);
+		    }
+	    }
     }
 
     protected ObjectMapper buildDefaultObjectMapper() {
@@ -96,7 +98,7 @@ protected ObjectMapper buildDefaultObjectMapper() {
      * Connect to a (presumably) different host, using the same username/password combos that were used for the same
      * connection. Useful in a development environment where you may have multiple clusters with the same admin
      * username/password combo, and you want to switch quickly from one to another.
-     * 
+     *
      * @param host
      */
     public void connect(String host) {
@@ -107,7 +109,7 @@ public void connect(String host) {
     /**
      * Connect to a (presumably) different MarkLogic Management API. The username/password are assumed to work for both
      * the Management API and the Admin API on port 8001.
-     * 
+     *
      * @param host
      * @param username
      * @param password
@@ -118,7 +120,7 @@ public void connect(String host, String username, String password) {
 
     /**
      * Connect to a (presumably) different MarkLogic Management API.
-     * 
+     *
      * @param host
      * @param username
      * @param password
@@ -140,7 +142,7 @@ public void connect(String host, String username, String password, String adminU
 
     /**
      * Constructs a new ClientHelper, using newClient().
-     * 
+     *
      * @return
      */
     public ClientHelper clientHelper() {
@@ -150,7 +152,7 @@ public ClientHelper clientHelper() {
     /**
      * Constructs a new DatabaseClient, using system properties to create an AppConfig instance which is used to create
      * a DatabaseClient.
-     * 
+     *
      * @return
      */
     public DatabaseClient newClient() {
@@ -159,7 +161,7 @@ public DatabaseClient newClient() {
 
     /**
      * Construct a new DatabaseClient, assuming DIGEST authentication.
-     * 
+     *
      * @param host
      * @param port
      * @param user
@@ -203,7 +205,7 @@ public String createRestApi(String name, Integer port) {
     /**
      * Convenience method since the "Default" group is usually the group that's wanted (and often the only one that
      * exists).
-     * 
+     *
      * @return
      */
     public Group group() {
@@ -222,7 +224,7 @@ public Group getGroup() {
     /**
      * The vast majority of the time, configuring trace events will be on the default group, so a convenience method is
      * exposed for this use case.
-     * 
+     *
      * @param events
      */
     public void trace(String... events) {
@@ -232,7 +234,7 @@ public void trace(String... events) {
     /**
      * The vast majority of the time, configuring trace events will be on the default group, so a convenience method is
      * exposed for this use case.
-     * 
+     *
      * @param events
      */
     public void untrace(String... events) {
@@ -276,7 +278,7 @@ public Server getServer() {
      * In order to get an amp, we need up to 4 things to uniquely identify based on
      * http://docs.marklogic.com/REST/GET/manage/v2/amps/[id-or-name] . TODO Could make this nicer, where a call is made
      * to the amps endpoint to find an amp with the given local name, and if only one exists, just use that.
-     * 
+     *
      * @param localName
      * @return
      */

src/main/java/com/marklogic/mgmt/api/Resource.java

@@ -43,7 +43,7 @@ public String save() {
             logger.info(format("Saved %s %s", name, label));
         }
         return format("[Path: %s; Resource ID: %s; HTTP status: %s]", receipt.getPath(), receipt.getResourceId(),
-                receipt.getResponse().getStatusCode());
+                receipt.getResponse() != null ? receipt.getResponse().getStatusCode() : "(none)");
     }
 
     /**
@@ -68,7 +68,7 @@ public String delete() {
      * TODO Not totally convinced about putting this method here, as it means that an instance of this is needed to get
      * a list of names. The other choices would be a method on the API class, but then that means the API class needs a
      * method per resource for getting a list of names, whereas with this approach, we have a single method.
-     * 
+     *
      * @return a list of names of all resources of this type.
      */
     public List<String> list() {
@@ -87,7 +87,7 @@ public boolean exists() {
     /**
      * Some resources, such as amps, require additional parameters in the URL to uniquely identify the resource. A
      * subclass can override this to provide those parameters.
-     * 
+     *
      * @return
      */
     public String[] getResourceUrlParams() {

src/main/java/com/marklogic/mgmt/api/security/Permission.java

@@ -1,24 +1,33 @@
 package com.marklogic.mgmt.api.security;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+
+@XmlAccessorType(XmlAccessType.FIELD)
 public class Permission {
 
-    private String roleName;
-    private String capability;
+	@JsonProperty("role-name")
+	@XmlElement(name = "role-name")
+	private String roleName;
+	private String capability;
 
-    public String getRoleName() {
-        return roleName;
-    }
+	public String getRoleName() {
+		return roleName;
+	}
 
-    public void setRoleName(String roleName) {
-        this.roleName = roleName;
-    }
+	public void setRoleName(String roleName) {
+		this.roleName = roleName;
+	}
 
-    public String getCapability() {
-        return capability;
-    }
+	public String getCapability() {
+		return capability;
+	}
 
-    public void setCapability(String capability) {
-        this.capability = capability;
-    }
+	public void setCapability(String capability) {
+		this.capability = capability;
+	}
 
 }