com.marklogic.appdeployer.export.databases.DatabaseExporter 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.export.databases;

import com.marklogic.appdeployer.ConfigDir;
import com.marklogic.appdeployer.export.impl.AbstractNamedResourceExporter;
import com.marklogic.appdeployer.export.impl.ExportInputs;
import com.marklogic.appdeployer.export.ExportedResources;
import com.marklogic.appdeployer.export.forests.ForestExporter;
import com.marklogic.mgmt.ManageClient;
import com.marklogic.mgmt.resource.ResourceManager;
import com.marklogic.mgmt.resource.databases.DatabaseManager;

import java.io.File;
import java.util.List;

/**
 * After the database is written, we want to find its forests and write them out as well, including the host name.
 * We'll offer an option in the future to remove the host.
 * 
 * This is rough - the database is exported with forest names, and a forest is exported with its database name. Can't
 * do both. Since we already deploy a database first and then deploy custom forests, we'll stick with that order and
 * drop the forest names from the database.
 */
public class DatabaseExporter extends AbstractNamedResourceExporter {

	private boolean exportForests = true;

	public DatabaseExporter(ManageClient manageClient, String... databaseNames) {
		super(manageClient, databaseNames);
	}

	@Override
	protected ResourceManager newResourceManager(ManageClient manageClient) {
		return new DatabaseManager(manageClient);
	}

	@Override
	protected File getResourceDirectory(File baseDir) {
		return new ConfigDir(baseDir).getDatabasesDir();
	}

	@Override
	protected String beforeResourceWrittenToFile(ExportInputs exportInputs, String payload) {
		return removeForestsSoDatabaseCanBeCreatedBeforeForestsAre(payload);
	}

	/**
	 * Currently only supports JSON.
	 *
	 * @param payload
	 * @return
	 */
	protected String removeForestsSoDatabaseCanBeCreatedBeforeForestsAre(String payload) {
		return removeJsonKeyFromPayload(payload, "forest");
	}

	@Override
	protected String[] getExportMessages() {
		return new String[]{"The 'forest' key was removed from each exported database so that databases can be deployed before forests."};
	}

	@Override
	public ExportedResources exportResources(File baseDir) {
		ExportedResources resources = super.exportResources(baseDir);
		if (isExportForests()) {
			resources = exportForests(baseDir, resources);
		}
		return resources;
	}

	protected ExportedResources exportForests(File baseDir, ExportedResources resources) {
		DatabaseManager dbMgr = new DatabaseManager(getManageClient());
		for (String dbName : getResourceNames()) {
			List forestNames = dbMgr.getForestNames(dbName);
			ForestExporter forestExporter = new ForestExporter(dbName, getManageClient(), forestNames.toArray(new String[]{}));
			resources.add(forestExporter.exportResources(baseDir));
		}
		return resources;
	}

	public boolean isExportForests() {
		return exportForests;
	}

	public void setExportForests(boolean exportForests) {
		this.exportForests = exportForests;
	}
}