framework/service/src/main/java/org/apache/ofbiz/service/ModelPermGroup.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.ofbiz.service;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.apache.ofbiz.base.util.UtilValidate;

/**
 * Service Permission Group Model Class
 */
@SuppressWarnings("serial")
public class ModelPermGroup implements Serializable {

    public static final String PERM_JOIN_AND = "AND";
    public static final String PERM_JOIN_OR = "OR";

    private List<ModelPermission> permissions = new LinkedList<>();
    private String joinType;

    /**
     * Sets join type.
     * @param joinType the join type
     */
    public void setJoinType(String joinType) {
        this.joinType = joinType;
    }

    /**
     * Gets permissions.
     * @return the permissions
     */
    public List<ModelPermission> getPermissions() {
        return permissions;
    }

    /**
     * Eval permissions map.
     * @param dctx the dctx
     * @param context the context
     * @return the map
     */
    public Map<String, Object> evalPermissions(DispatchContext dctx, Map<String, ? extends Object> context) {
        List<String> permissionErrors = new ArrayList<>();
        if (UtilValidate.isNotEmpty(permissions)) {
            boolean foundOne = false;
            for (ModelPermission perm: permissions) {
                Map<String, Object> permResult = perm.evalPermission(dctx, context);
                if (ServiceUtil.isSuccess(permResult)) {
                    foundOne = true;
                } else {
                    ServiceUtil.addErrors(permissionErrors, null, permResult);
                    if (joinType.equals(PERM_JOIN_AND)) {
                        return permResult;
                    }
                }
            }
            if (!foundOne) {
                return ServiceUtil.returnError(permissionErrors);
            }
        }
        return ServiceUtil.returnSuccess();
    }
}