com.marklogic.appdeployer.command.security.DeployPrivilegesCommand 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
The newest version!
/*
 * 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.security;

import com.fasterxml.jackson.databind.node.ObjectNode;
import com.marklogic.appdeployer.command.*;
import com.marklogic.mgmt.PayloadParser;
import com.marklogic.mgmt.api.configuration.Configuration;
import com.marklogic.mgmt.api.security.Privilege;
import com.marklogic.mgmt.resource.ResourceManager;
import com.marklogic.mgmt.resource.security.PrivilegeManager;
import org.apache.commons.lang3.builder.EqualsBuilder;

import java.io.File;
import java.util.function.BiPredicate;

public class DeployPrivilegesCommand extends AbstractResourceCommand implements SupportsCmaCommand {

	private boolean removeRolesBeforeSaving = true;

	public DeployPrivilegesCommand() {
		setExecuteSortOrder(SortOrderConstants.DEPLOY_PRIVILEGES);
		setUndoSortOrder(SortOrderConstants.DELETE_PRIVILEGES);

		setSupportsResourceMerging(true);
		setResourceClassType(Privilege.class);
	}

	@Override
	protected File[] getResourceDirs(CommandContext context) {
		return findResourceDirs(context, configDir -> configDir.getPrivilegesDir());
	}

	@Override
	protected ResourceManager getResourceManager(CommandContext context) {
		return new PrivilegeManager(context.getManageClient());
	}

	@Override
	protected String adjustPayloadBeforeSavingResource(CommandContext context, File f, String payload) {
		payload = super.adjustPayloadBeforeSavingResource(context, f, payload);
		return removeRolesBeforeSaving ? new PayloadParser().excludeProperties(payload, "role") : payload;
	}

	@Override
	public boolean cmaShouldBeUsed(CommandContext context) {
		return context.getAppConfig().getCmaConfig().isDeployPrivileges();
	}

	@Override
	public void addResourceToConfiguration(ObjectNode resource, Configuration configuration) {
		if (removeRolesBeforeSaving && resource != null && resource.has("role")) {
			resource.remove("role");
		}

		configuration.addPrivilege(resource);
	}

	@Override
	protected void deployConfiguration(CommandContext context, Configuration config) {
		if (context.getAppConfig().getCmaConfig().isCombineRequests()) {
			logger.info("Adding privileges to combined CMA request");
			context.addCmaConfigurationToCombinedRequest(config);
		} else {
			super.deployConfiguration(context, config);
		}
	}

	@Override
	protected BiPredicate getBiPredicateForMergingResources() {
		return new PrivilegeBiPredicate();
	}

	public boolean isRemoveRolesBeforeSaving() {
		return removeRolesBeforeSaving;
	}

	public void setRemoveRolesBeforeSaving(boolean removeRolesBeforeSaving) {
		this.removeRolesBeforeSaving = removeRolesBeforeSaving;
	}
}

class PrivilegeBiPredicate implements BiPredicate {
	@Override
	public boolean test(ResourceReference reference1, ResourceReference reference2) {
		EqualsBuilder b = new EqualsBuilder();

		final ObjectNode node1 = reference1.getObjectNode();
		final ObjectNode node2 = reference2.getObjectNode();

		b.append(node1.get("privilege-name").asText(), node2.get("privilege-name").asText());
		b.append(node1.has("kind") ? node1.get("kind").asText() : null, node2.has("kind") ? node2.get("kind").asText() : null);

		return b.isEquals();
	}
}