#110 ModulesLoader now supports loading modules from multiple paths

Author: rjrudin

gradle.properties

@@ -1,3 +1,4 @@
 group=com.marklogic
 javadocsDir=../gh-pages-marklogic-java/javadocs
-version=3.11.0
+#version=3.11.0
+version=3.12.develop

src/main/java/com/marklogic/client/ext/modulesloader/Modules.java

@@ -1,73 +1,87 @@
 package com.marklogic.client.ext.modulesloader;
 
-import java.util.List;
-
 import org.springframework.core.io.Resource;
 
+import java.util.ArrayList;
+import java.util.List;
+
 public class Modules {
 
-    private List<Resource> assets;
-    private List<Resource> services;
-    private List<Resource> assetDirectories;
-    private List<Resource> transforms;
-    private List<Resource> options;
-    private List<Resource> namespaces;
-    private Resource propertiesFile;
-
-    public List<Resource> getServices() {
-        return services;
-    }
-
-    public List<Resource> getTransforms() {
-        return transforms;
-    }
-
-    public List<Resource> getOptions() {
-        return options;
-    }
-
-    public void setServices(List<Resource> resources) {
-        this.services = resources;
-    }
-
-    public void setTransforms(List<Resource> transforms) {
-        this.transforms = transforms;
-    }
-
-    public void setOptions(List<Resource> queryOptions) {
-        this.options = queryOptions;
-    }
-
-    public List<Resource> getNamespaces() {
-        return namespaces;
-    }
-
-    public void setNamespaces(List<Resource> namespaces) {
-        this.namespaces = namespaces;
-    }
-
-    public Resource getPropertiesFile() {
-        return propertiesFile;
-    }
-
-    public void setPropertiesFile(Resource propertiesFile) {
-        this.propertiesFile = propertiesFile;
-    }
-
-    public List<Resource> getAssetDirectories() {
-        return assetDirectories;
-    }
-
-    public void setAssetDirectories(List<Resource> assetDirectories) {
-        this.assetDirectories = assetDirectories;
-    }
-
-    public List<Resource> getAssets() {
-        return assets;
-    }
-
-    public void setAssets(List<Resource> assets) {
-        this.assets = assets;
-    }
+	private List<Resource> assetDirectories;
+	private List<Resource> namespaces;
+	private List<Resource> options;
+	private List<Resource> services;
+	private List<Resource> transforms;
+	private Resource propertiesFile;
+
+	public void addModules(Modules modules) {
+		assetDirectories = addLists(assetDirectories, modules.getAssetDirectories());
+		namespaces = addLists(namespaces, modules.getNamespaces());
+		options = addLists(options, modules.getOptions());
+		services = addLists(services, modules.getServices());
+		transforms = addLists(transforms, modules.getTransforms());
+		if (modules.getPropertiesFile() != null) {
+			propertiesFile = modules.getPropertiesFile();
+		}
+	}
+
+	protected List<Resource> addLists(List<Resource> myList, List<Resource> otherList) {
+		if (otherList == null) {
+			return myList;
+		}
+		if (myList == null) {
+			myList = new ArrayList<>();
+		}
+		myList.addAll(otherList);
+		return myList;
+	}
+
+	public List<Resource> getServices() {
+		return services;
+	}
+
+	public List<Resource> getTransforms() {
+		return transforms;
+	}
+
+	public List<Resource> getOptions() {
+		return options;
+	}
+
+	public void setServices(List<Resource> resources) {
+		this.services = resources;
+	}
+
+	public void setTransforms(List<Resource> transforms) {
+		this.transforms = transforms;
+	}
+
+	public void setOptions(List<Resource> queryOptions) {
+		this.options = queryOptions;
+	}
+
+	public List<Resource> getNamespaces() {
+		return namespaces;
+	}
+
+	public void setNamespaces(List<Resource> namespaces) {
+		this.namespaces = namespaces;
+	}
+
+	public Resource getPropertiesFile() {
+		return propertiesFile;
+	}
+
+	public void setPropertiesFile(Resource propertiesFile) {
+		this.propertiesFile = propertiesFile;
+	}
+
+	public List<Resource> getAssetDirectories() {
+		return assetDirectories;
+	}
+
+	public void setAssetDirectories(List<Resource> assetDirectories) {
+		this.assetDirectories = assetDirectories;
+	}
 
 }

src/main/java/com/marklogic/client/ext/modulesloader/ModulesLoader.java

@@ -1,25 +1,35 @@
 package com.marklogic.client.ext.modulesloader;
 
-import java.io.File;
-import java.util.Set;
-
 import com.marklogic.client.DatabaseClient;
 import org.springframework.core.io.Resource;
 
+import java.util.Set;
+
 /**
  * Interface for objects that can load a set of modules via the REST API, which is intended to include not just what the
  * REST API calls "assets" (regular modules), but also options, services, transforms, and namespaces.
  */
 public interface ModulesLoader {
 
-    /**
-     * Use the given DatabaseClient to load modules found in the given directory. Return a set containing any files that
-     * were loaded.
-     *
-     * @param directory
-     * @param modulesFinder
-     * @param client
-     * @return
-     */
-    Set<Resource> loadModules(String directory, ModulesFinder modulesFinder, DatabaseClient client);
+	/**
+	 * Use the given DatabaseClient to load modules found in the given directory. Return a set containing any files that
+	 * were loaded.
+	 *
+	 * @param directory
+	 * @param modulesFinder
+	 * @param client
+	 * @return
+	 */
+	Set<Resource> loadModules(String directory, ModulesFinder modulesFinder, DatabaseClient client);
+
+	/**
+	 * Prefer this method when loading modules from multiple paths, as the non-REST modules from all paths should be
+	 * loaded in a single batch.
+	 *
+	 * @param client
+	 * @param modulesFinder
+	 * @param paths
+	 * @return
+	 */
+	Set<Resource> loadModules(DatabaseClient client, ModulesFinder modulesFinder, String... paths);
 }

src/main/java/com/marklogic/client/ext/modulesloader/impl/DefaultModulesLoader.java

@@ -127,18 +127,45 @@ public void initializeDefaultTaskExecutor() {
 	 * because the /v1/ext endpoint is too slow when there are e.g. hundreds of modules or more - asset modules are
 	 * instead loaded via AssetFileLoader.
 	 */
-	public Set<Resource> loadModules(String baseDir, ModulesFinder modulesFinder, DatabaseClient client) {
+	@Override
+	public Set<Resource> loadModules(DatabaseClient client, ModulesFinder modulesFinder, String... paths) {
+		List<String> pathsList = Arrays.asList(paths);
+
 		if (logger.isDebugEnabled()) {
-			logger.debug("Loading modules from base directory: " + baseDir);
+			logger.debug("Loading modules from paths: " + pathsList);
 		}
+
 		setDatabaseClient(client);
 
 		if (modulesManager != null) {
 			modulesManager.initialize();
 		}
 
-		Modules modules = modulesFinder.findModules(baseDir);
+		Modules allModules = new Modules();
+		for (String path : paths) {
+			allModules.addModules(modulesFinder.findModules(path));
+		}
+
+		if (logger.isDebugEnabled()) {
+			logger.debug("Finished loading modules from paths: " + pathsList);
+		}
+
+		return loadModules(allModules);
+	}
+
+	/**
+	 * Just delegates to the loadModules method that takes an array of paths.
+	 *
+	 * @param baseDir
+	 * @param modulesFinder
+	 * @param client
+	 * @return
+	 */
+	public Set<Resource> loadModules(String baseDir, ModulesFinder modulesFinder, DatabaseClient client) {
+		return loadModules(client, modulesFinder, baseDir);
+	}
 
+	protected Set<Resource> loadModules(Modules modules) {
 		if (taskExecutor == null) {
 			initializeDefaultTaskExecutor();
 		}
@@ -155,10 +182,6 @@ public Set<Resource> loadModules(String baseDir, ModulesFinder modulesFinder, Da
 		waitForTaskExecutorToFinish();
 		rethrowRestModulesFailureIfOneExists();
 
-		if (logger.isDebugEnabled()) {
-			logger.debug("Finished loading modules from base directory: " + baseDir);
-		}
-
 		return loadedModules;
 	}