trunk/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/Context.java

/*
 * 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;

import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.api.Tree;
import org.apache.jackrabbit.oak.plugins.tree.TreeContext;
import org.apache.jackrabbit.oak.plugins.tree.TreeLocation;
import org.jetbrains.annotations.NotNull;

/**
 * {@code Context} represents item related information in relation to a
 * dedicated {@link org.apache.jackrabbit.oak.spi.security.SecurityConfiguration}.
 * This information allows to determine if a given {@code Tree} or {@link PropertyState}
 * is defined by or related to the security model provided by the configuration.
 */
public interface Context extends TreeContext {

    Context DEFAULT = new Default();

    /**
     * Default implementation of the {@code Context} interface that always returns
     * {@code false}.
     */
    class Default implements Context {

        @Override
        public boolean definesProperty(@NotNull Tree parent, @NotNull PropertyState property) {
            return false;
        }

        @Override
        public boolean definesContextRoot(@NotNull Tree tree) {
            return false;
        }

        @Override
        public boolean definesTree(@NotNull Tree tree) {
            return false;
        }

        @Override
        public boolean definesLocation(@NotNull TreeLocation location) {
            return false;
        }

        @Override
        public boolean definesInternal(@NotNull Tree tree) {
            return false;
        }
    }
}