001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019package org.apache.isis.extensions.secman.api.permission;
020
021import java.io.Serializable;
022import java.util.Collection;
023
024import org.apache.isis.core.metamodel.services.appfeat.ApplicationFeatureId;
025
026/**
027 * Strategy for determining which permission should apply when there are multiple that apply for a particular target
028 * feature Id, and which may conflict with each other.
029 *
030 * <p>
031 *     All implementations of this interface must be {@link java.io.Serializable}, because
032 *     an instance is serialized into {@link org.apache.isis.extensions.secman.api.permission.ApplicationPermissionValueSet}.
033 * </p>
034 */
035public interface PermissionsEvaluationService extends Serializable {
036
037    /**
038     * @param targetMemberId - the target (member) feature to be evaluated
039     * @param mode - the mode required, ie {@link org.apache.isis.extensions.secman.api.permission.ApplicationPermissionMode#VIEWING viewing} or {@link org.apache.isis.extensions.secman.api.permission.ApplicationPermissionMode#CHANGING changing}.
040     * @param permissionValues - permissions to evaluate, guaranteed to passed through in natural order, as per {@link org.apache.isis.extensions.secman.api.permission.ApplicationPermissionValue.Comparators#natural()}.
041     */
042    ApplicationPermissionValueSet.Evaluation evaluate(
043            final ApplicationFeatureId targetMemberId,
044            final ApplicationPermissionMode mode,
045            final Collection<ApplicationPermissionValue> permissionValues);
046
047}