Loading modules

One of the main features of ml-javaclient-util is its support for loading modules into a MarkLogic modules database.

Loading modules

Starting in version 3.0.0, all modules are loaded via the REST API, as shown below. For more information, please see Loading files.

DatabaseClient client = DatabaseClientFactory.newClient(...); // Use the ML Java Client API
AssetFileLoader assetFileLoader = new AssetFileLoader(client); // Uses the REST API to load asset modules
DefaultModulesLoader modulesLoader = new DefaultModulesLoader(assetLoader);
File modulesDir = new File("src/main/ml-modules");
ModulesFinder modulesFinder = new DefaultModulesFinder(); // Allows for adjusting where modules are stored on a filesystem
modulesLoader.loadModules(modulesDir, modulesFinder, client);

Prior to version 3.0.0, loading modules was accomplished via a combination of XCC and the REST API:

DatabaseClient client = DatabaseClientFactory.newClient(...); // Use the ML Java Client API
XccAssetLoader assetLoader = new XccAssetLoader(client); // Can use XCC or the REST API to load asset modules
DefaultModulesLoader modulesLoader = new DefaultModulesLoader(assetLoader);
File modulesDir = new File("src/main/ml-modules");
ModulesFinder modulesFinder = new DefaultModulesFinder(); // Allows for adjusting where modules are stored on a filesystem
modulesLoader.loadModules(modulesDir, modulesFinder, client);

Where modules should be stored

See this ml-gradle Wiki page for information on the expected directory structure for modules, including REST API modules and non-REST API modules.