/*
 * 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 java.util.Set;
import javax.annotation.Nonnull;

/**
 * The {@code PrivilegeDefinition} interface defines the characteristics of
 * a JCR {@link javax.jcr.security.Privilege}.
 */
public interface PrivilegeDefinition {

    /**
     * The internal name of this privilege.
     *
     * @return the internal name.
     */
    @Nonnull
    String getName();

    /**
     * Returns {@code true} if the privilege described by this definition
     * is abstract.
     *
     * @return {@code true} if the resulting privilege is abstract;
     * {@code false} otherwise.
     */
    boolean isAbstract();

    /**
     * Returns the internal names of the declared aggregated privileges or
     * an empty array if the privilege defined by this definition isn't
     * an aggregate.
     *
     * @return The internal names of the aggregated privileges or an empty array.
     */
    @Nonnull
    Set<String> getDeclaredAggregateNames();
}