org.apache.jackrabbit.oak.spi.security.privilege.PrivilegeUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.jackrabbit.oak.spi.security.privilege;

import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.api.Root;
import org.apache.jackrabbit.oak.api.Tree;
import org.apache.jackrabbit.oak.api.Type;
import org.apache.jackrabbit.oak.namepath.NamePathMapper;
import org.apache.jackrabbit.oak.plugins.tree.TreeUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.jcr.security.AccessControlException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

/**
 * Privilege management related utility methods.
 */
public final class PrivilegeUtil implements PrivilegeConstants {

    private PrivilegeUtil() {}

    /**
     * Returns the root tree for all privilege definitions stored in the content
     * repository.
     *
     * @return The privileges root.
     */
    @NotNull
    public static Tree getPrivilegesTree(@NotNull Root root) {
        return root.getTree(PRIVILEGES_PATH);
    }

    /**
     * Reads the privilege definition stored in the specified definition tree.
     * Note, that this utility does not check the existence nor the node type
     * of the specified tree.
     *
     * @param definitionTree An existing tree storing a privilege definition.
     * @return A new instance of {@code PrivilegeDefinition}.
     */
    @NotNull
    public static PrivilegeDefinition readDefinition(@NotNull Tree definitionTree) {
        String name = definitionTree.getName();
        boolean isAbstract = TreeUtil.getBoolean(definitionTree, REP_IS_ABSTRACT);
        Iterable declAggrNames = null;
        PropertyState property = definitionTree.getProperty(REP_AGGREGATES);
        if (property != null) {
            declAggrNames = property.getValue(Type.NAMES);
        }
        return new ImmutablePrivilegeDefinition(name, isAbstract, declAggrNames);
    }

    /**
     * Convert the given JCR privilege names to Oak names.
     * 
     * @param jcrNames The JCR names of privileges
     * @param namePathMapper The {@link NamePathMapper} to use for the conversion.
     * @return A set of Oak names
     * @throws AccessControlException If the given JCR names cannot be converted.
     */
    @NotNull
    public static Set getOakNames(@Nullable String[] jcrNames, @NotNull NamePathMapper namePathMapper) throws AccessControlException {
        Set oakNames;
        if (jcrNames == null || jcrNames.length == 0) {
            oakNames = Collections.emptySet();
        } else {
            oakNames = new HashSet<>(jcrNames.length);
            for (String jcrName : jcrNames) {
                String oakName = getOakName(jcrName, namePathMapper);
                oakNames.add(oakName);
            }
        }
        return oakNames;
    }

    /**
     * Convert the given JCR privilege name to an Oak name.
     * 
     * @param jcrName The JCR name of a privilege.
     * @param namePathMapper The {@link NamePathMapper} to use for the conversion.
     * @return the Oak name of the given privilege.
     * @throws AccessControlException If the specified name is null or cannot be resolved to an Oak name.
     */
    @NotNull
    public static String getOakName(@Nullable String jcrName, @NotNull NamePathMapper namePathMapper) throws AccessControlException {
        if (jcrName == null) {
            throw new AccessControlException("Invalid privilege name 'null'");
        }
        String oakName = namePathMapper.getOakNameOrNull(jcrName);
        if (oakName == null) {
            throw new AccessControlException("Cannot resolve privilege name " + jcrName);
        }
        return oakName;
    }
}