New Export API

Author: Rob Rudin

src/main/java/com/marklogic/appdeployer/export/AbstractNamedResourceExporter.java

@@ -0,0 +1,81 @@
+package com.marklogic.appdeployer.export;
+
+import com.marklogic.mgmt.ManageClient;
+import com.marklogic.mgmt.ResourceManager;
+import org.springframework.util.FileCopyUtils;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Can use this as a parent class when exporting a resource that can be referred to via a single name, and when that
+ * name makes sense to use as the name of the file that's exported.
+ */
+public abstract class AbstractNamedResourceExporter extends AbstractResourceExporter {
+
+	private String[] resourceNames;
+
+	protected AbstractNamedResourceExporter(ManageClient manageClient, String... resourceNames) {
+		super(manageClient);
+		this.resourceNames = resourceNames;
+	}
+
+	protected abstract ResourceManager newResourceManager(ManageClient manageClient);
+
+	protected abstract File getResourceDirectory(File baseDir);
+
+	@Override
+	public List<File> exportResources(File baseDir) {
+		ResourceManager mgr = newResourceManager(getManageClient());
+		File resourceDir = getResourceDirectory(baseDir);
+		resourceDir.mkdirs();
+		List<File> files = new ArrayList<>();
+		for (String resourceName : resourceNames) {
+			File f = exportToFile(mgr, resourceName, resourceDir);
+			if (f != null) {
+				files.add(f);
+			}
+		}
+		return files;
+	}
+
+	protected File exportToFile(ResourceManager mgr, String resourceName, File resourceDir) {
+		File f = null;
+		try {
+			if (isFormatXml()) {
+				f = exportToXml(mgr, resourceName, resourceDir);
+			} else {
+				f = exportToJson(mgr, resourceName, resourceDir);
+			}
+		} catch (IOException ex) {
+			logger.warn(format("Unable to export resource with name %s to resource directory %s, cause: %s",
+				resourceName, resourceDir.getAbsolutePath(), ex.getMessage()), ex);
+		}
+		return f;
+	}
+
+	protected File exportToXml(ResourceManager mgr, String resourceName, File resourceDir) throws IOException {
+		String xml = mgr.getPropertiesAsXml(resourceName).getPrettyXml();
+		File f = new File(resourceDir, resourceName + ".xml");
+		logWritingFile(resourceName, f);
+		FileCopyUtils.copy(xml.getBytes(), f);
+		return f;
+	}
+
+	protected File exportToJson(ResourceManager mgr, String resourceName, File resourceDir) throws IOException {
+		String json = mgr.getPropertiesAsJson(resourceName);
+		File f = new File(resourceDir, resourceName + ".json");
+		logWritingFile(resourceName, f);
+		FileCopyUtils.copy(json.getBytes(), f);
+		return f;
+	}
+
+	protected void logWritingFile(String resourceName, File file) {
+		if (logger.isInfoEnabled()) {
+			logger.info(format("Exporting resource %s to file %s", resourceName, file.getAbsolutePath()));
+		}
+	}
+
+}

src/main/java/com/marklogic/appdeployer/export/AbstractResourceExporter.java

@@ -0,0 +1,36 @@
+package com.marklogic.appdeployer.export;
+
+import com.marklogic.client.helper.LoggingObject;
+import com.marklogic.mgmt.ManageClient;
+
+/**
+ * Base class that provides a few conveniences for implementing ResourceExporter.
+ *
+ * TODO Should be able to add TaskExecutor support to allow for parallelizing requests to the Management API to
+ * export resources.
+ */
+public abstract class AbstractResourceExporter extends LoggingObject implements ResourceExporter {
+
+	private ManageClient manageClient;
+	private String format = "xml";
+
+	protected AbstractResourceExporter(ManageClient manageClient) {
+		this.manageClient = manageClient;
+	}
+
+	protected boolean isFormatXml() {
+		return "xml".equalsIgnoreCase(format);
+	}
+
+	public String getFormat() {
+		return format;
+	}
+
+	public void setFormat(String format) {
+		this.format = format;
+	}
+
+	public ManageClient getManageClient() {
+		return manageClient;
+	}
+}

src/main/java/com/marklogic/appdeployer/export/CompositeResourceExporter.java

@@ -0,0 +1,58 @@
+package com.marklogic.appdeployer.export;
+
+import com.marklogic.mgmt.ManageClient;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * Lets you combine many instances of ResourceExporter and invoke them all at once (could parallelize this in the
+ * future).
+ */
+public class CompositeResourceExporter extends AbstractResourceExporter {
+
+	private List<ResourceExporter> resourceExporters;
+	private boolean overrideFormatOnExporters = true;
+
+	public CompositeResourceExporter(ManageClient manageClient, ResourceExporter... resourceExporters) {
+		super(manageClient);
+		this.resourceExporters = new ArrayList<>();
+		for (ResourceExporter exporter : resourceExporters) {
+			this.resourceExporters.add(exporter);
+		}
+	}
+
+	public void add(ResourceExporter exporter) {
+		this.resourceExporters.add(exporter);
+	}
+
+	@Override
+	public List<File> exportResources(File baseDir) {
+		List<File> files = new ArrayList<>();
+		for (ResourceExporter exporter : resourceExporters) {
+			if (overrideFormatOnExporters && exporter instanceof AbstractResourceExporter) {
+				((AbstractResourceExporter) exporter).setFormat(getFormat());
+			}
+			files.addAll(exporter.exportResources(baseDir));
+		}
+		return files;
+	}
+
+	public boolean isOverrideFormatOnExporters() {
+		return overrideFormatOnExporters;
+	}
+
+	public void setOverrideFormatOnExporters(boolean overrideFormatOnExporters) {
+		this.overrideFormatOnExporters = overrideFormatOnExporters;
+	}
+
+	public List<ResourceExporter> getResourceExporters() {
+		return resourceExporters;
+	}
+
+	public void setResourceExporters(List<ResourceExporter> resourceExporters) {
+		this.resourceExporters = resourceExporters;
+	}
+}

src/main/java/com/marklogic/appdeployer/export/Exporter.java

@@ -0,0 +1,46 @@
+package com.marklogic.appdeployer.export;
+
+import com.marklogic.appdeployer.export.security.RoleExporter;
+import com.marklogic.appdeployer.export.security.UserExporter;
+import com.marklogic.mgmt.ManageClient;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Intent is to provide a fluent-ish way of composing comands for exporting resources.
+ */
+public class Exporter {
+
+	private CompositeResourceExporter compositeExporter;
+	private ManageClient manageClient;
+
+	public static Exporter client(ManageClient manageClient) {
+		return new Exporter(manageClient);
+	}
+
+	public Exporter(ManageClient manageClient) {
+		this.manageClient = manageClient;
+		compositeExporter = new CompositeResourceExporter(manageClient);
+	}
+
+	public Exporter format(String xmlOrJson) {
+		compositeExporter.setFormat(xmlOrJson);
+		return this;
+	}
+
+	public List<File> export(File baseDir) {
+		return compositeExporter.exportResources(baseDir);
+	}
+
+	public Exporter users(String... usernames) {
+		compositeExporter.add(new UserExporter(manageClient, usernames));
+		return this;
+	}
+
+	public Exporter roles(String... roleNames) {
+		compositeExporter.add(new RoleExporter(manageClient, roleNames));
+		return this;
+	}
+
+}

src/main/java/com/marklogic/appdeployer/export/ResourceExporter.java

@@ -0,0 +1,17 @@
+package com.marklogic.appdeployer.export;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Interface for exporting one or more MarkLogic resources via the Management API to disk.
+ */
+public interface ResourceExporter {
+
+	/**
+	 * @param baseDir
+	 * @return a list of Files, one for each resource that was exported; expectation is this will mostly be for reporting
+	 * reasons
+	 */
+	List<File> exportResources(File baseDir);
+}

src/main/java/com/marklogic/appdeployer/export/security/RoleExporter.java

@@ -0,0 +1,26 @@
+package com.marklogic.appdeployer.export.security;
+
+import com.marklogic.appdeployer.ConfigDir;
+import com.marklogic.appdeployer.export.AbstractNamedResourceExporter;
+import com.marklogic.mgmt.ManageClient;
+import com.marklogic.mgmt.ResourceManager;
+import com.marklogic.mgmt.security.RoleManager;
+
+import java.io.File;
+
+public class RoleExporter extends AbstractNamedResourceExporter {
+
+	public RoleExporter(ManageClient manageClient, String... usernames) {
+		super(manageClient, usernames);
+	}
+
+	@Override
+	protected ResourceManager newResourceManager(ManageClient manageClient) {
+		return new RoleManager(manageClient);
+	}
+
+	@Override
+	protected File getResourceDirectory(File baseDir) {
+		return new File(new ConfigDir(baseDir).getSecurityDir(), "roles");
+	}
+}

src/main/java/com/marklogic/appdeployer/export/security/UserExporter.java

@@ -0,0 +1,26 @@
+package com.marklogic.appdeployer.export.security;
+
+import com.marklogic.appdeployer.ConfigDir;
+import com.marklogic.appdeployer.export.AbstractNamedResourceExporter;
+import com.marklogic.mgmt.ManageClient;
+import com.marklogic.mgmt.ResourceManager;
+import com.marklogic.mgmt.security.UserManager;
+
+import java.io.File;
+
+public class UserExporter extends AbstractNamedResourceExporter {
+
+	public UserExporter(ManageClient manageClient, String... usernames) {
+		super(manageClient, usernames);
+	}
+
+	@Override
+	protected ResourceManager newResourceManager(ManageClient manageClient) {
+		return new UserManager(manageClient);
+	}
+
+	@Override
+	protected File getResourceDirectory(File baseDir) {
+		return new File(new ConfigDir(baseDir).getSecurityDir(), "users");
+	}
+}

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

@@ -60,6 +60,11 @@ public String getAsJson(String resourceNameOrId, String... resourceUrlParams) {
         return manageClient.getJson(path);
     }
 
+    public String getPropertiesAsJson(String resourceNameOrId, String... resourceUrlParams) {
+        String path = appendParamsAndValuesToPath(getPropertiesPath(resourceNameOrId, resourceUrlParams));
+        return useAdminUser() ? manageClient.getJsonAsAdmin(path) : manageClient.getJson(path);
+    }
+
     /**
      * Determines whether to create a new resource or update an existing one based on the contents of the payload.
      */

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

@@ -77,4 +77,12 @@ public interface ResourceManager {
      * @return
      */
     public Fragment getPropertiesAsXml(String resourceNameOrId, String... resourceUrlParams);
+
+	/**
+	 * @param resourceNameOrId
+	 * @param resourceUrlParams
+	 * @return
+	 */
+	public String getPropertiesAsJson(String resourceNameOrId, String... resourceUrlParams);
+
 }

src/test/java/com/marklogic/appdeployer/export/ExportTest.java

@@ -0,0 +1,28 @@
+package com.marklogic.appdeployer.export;
+
+import com.marklogic.appdeployer.AbstractAppDeployerTest;
+import org.junit.Test;
+
+import java.io.File;
+import java.util.List;
+
+public class ExportTest extends AbstractAppDeployerTest {
+
+	@Test
+	public void test() throws Exception {
+
+		// Define the directory to export to
+		File baseDir = new File("build/export-test");
+		baseDir.mkdirs();
+
+		List<File> exportedFiles =
+			Exporter.client(manageClient)
+			.users("admin", "nobody")
+			.roles("admin", "rest-admin", "rest-reader")
+			.format("xml")
+			.export(baseDir);
+
+		// Export!
+		System.out.println(exportedFiles);
+	}
+}