org.apache.jackrabbit.oak.spi.security.authorization.permission.RepositoryPermission Maven / Gradle / Ivy

/*
 * 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.authorization.permission;

/**
 * The {@link RepositoryPermission} allows to evaluate permissions that have
 * been defined on the repository level and which consequently are not bound
 * to a particular item.
 *
 * @see org.apache.jackrabbit.oak.spi.security.authorization.permission.PermissionProvider#getRepositoryPermission()
 */
public interface RepositoryPermission {

    /**
     * Returns {@code true} if the specified repository level permissions are
     * {@code granted}; false otherwise.
     *
     * @param repositoryPermissions Any valid repository level permission such as
     * for example:
     * 
     *     {@link Permissions#NAMESPACE_MANAGEMENT}
     *     {@link Permissions#NODE_TYPE_DEFINITION_MANAGEMENT}
     *     {@link Permissions#PRIVILEGE_MANAGEMENT}
     *     {@link Permissions#WORKSPACE_MANAGEMENT}
     * 
     * @return {@code true} if the specified repository level permissions are
     * {@code granted}; {@code false} otherwise
     * @see Permissions#isRepositoryPermission(long)
     */
    boolean isGranted(long repositoryPermissions);

    /**
     * {@code RepositoryPermission} instance that always returns {@code false}.
     */
    RepositoryPermission EMPTY = new RepositoryPermission() {
        @Override
        public boolean isGranted(long repositoryPermissions) {
            return false;
        }
    };

    /**
     * {@code RepositoryPermission} instance that always returns {@code true}.
     */
    RepositoryPermission ALL = new RepositoryPermission() {
        @Override
        public boolean isGranted(long repositoryPermissions) {
            return true;
        }
    };
}