com.marklogic.appdeployer.command.forests.DeployCustomForestsCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ml-app-deployer Show documentation
Java client for the MarkLogic REST Management API and for deploying applications to MarkLogic
There is a newer version: 5.0.0
/*
 * Copyright (c) 2023 MarkLogic Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.marklogic.appdeployer.command.forests;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.marklogic.appdeployer.ConfigDir;
import com.marklogic.appdeployer.command.AbstractCommand;
import com.marklogic.appdeployer.command.CommandContext;
import com.marklogic.appdeployer.command.SortOrderConstants;
import com.marklogic.mgmt.PayloadParser;
import com.marklogic.mgmt.api.configuration.Configuration;
import com.marklogic.mgmt.resource.forests.ForestManager;

import java.io.File;
import java.util.Iterator;

/**
 * Use this command when you want precise control over the forests that are created for a database. It processes
 * each directory under ml-config/forests (the name of the directory does not matter, but it makes sense to name
 * it after the database that the forests belong to), and each file in a directory can have a single forest object
 * or an array of forest objects.
 * 
 * You can also set customForestsPath to specify a directory other than "forest" as the path that contains
 * directories of custom forests. This allows you to easily support different custom forests in different
 * environments.
 */
public class DeployCustomForestsCommand extends AbstractCommand {

	private String customForestsPath = "forests";
	private PayloadParser payloadParser;

	public DeployCustomForestsCommand() {
		setExecuteSortOrder(SortOrderConstants.DEPLOY_FORESTS);
	}

	@Override
	public void execute(CommandContext context) {
		Configuration configuration = null;
		if (context.getAppConfig().getCmaConfig().isDeployForests()) {
			configuration = new Configuration();
		}

		for (ConfigDir configDir : context.getAppConfig().getConfigDirs()) {
			File dir = new File(configDir.getBaseDir(), customForestsPath);
			if (dir != null && dir.exists()) {
				payloadParser = new PayloadParser();
				for (File f : dir.listFiles()) {
					if (f.isDirectory()) {
						processDirectory(f, context, configuration);
					}
				}
			} else {
				logResourceDirectoryNotFound(dir);
			}
		}

		if (configuration != null) {
			deployConfiguration(context, configuration);
		}
	}

	/**
	 * Supports JSON files with a single payload or an array of payloads, or an XML file with a single payload.
	 *
	 * @param dir
	 * @param context
	 */
	protected void processDirectory(File dir, CommandContext context, Configuration configuration) {
		if (logger.isInfoEnabled()) {
			logger.info("Processing custom forest files in directory: " + dir.getAbsolutePath());
		}
		ForestManager mgr = new ForestManager(context.getManageClient());

		for (File f : listFilesInDirectory(dir)) {
			if (logger.isInfoEnabled()) {
				logger.info("Processing forests in file: " + f.getAbsolutePath());
			}
			String payload = readResourceFromFile(context, f);

			if (payloadParser.isJsonPayload(payload)) {
				if (configuration != null) {
					addForestsToCmaConfiguration(context, payload, configuration);
				} else {
					mgr.saveJsonForests(payload);
				}
			} else {
				if (configuration != null) {
					configuration.addForest(convertPayloadToObjectNode(context, payload));
				} else {
					mgr.save(payload);
				}
			}
		}
	}

	protected void addForestsToCmaConfiguration(CommandContext context, String payload, Configuration configuration) {
		JsonNode node = payloadParser.parseJson(payload);
		if (node.isArray()) {
			Iterator iter = node.iterator();
			while (iter.hasNext()) {
				configuration.addForest((ObjectNode) iter.next());
			}
		} else {
			configuration.addForest((ObjectNode) node);
		}
	}

	public void setCustomForestsPath(String customForestsPath) {
		this.customForestsPath = customForestsPath;
	}
}