001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.kim;
017
018import org.apache.commons.lang.StringUtils;
019import org.kuali.rice.kim.api.KimConstants;
020import org.kuali.rice.kim.api.permission.Permission;
021import org.kuali.rice.kim.impl.permission.PermissionBo;
022import org.kuali.rice.kns.kim.permission.PermissionTypeServiceBase;
023
024import java.util.ArrayList;
025import java.util.Collections;
026import java.util.List;
027import java.util.Map;
028
029/**
030 * Type service for the 'View Field' KIM type which matches on the id for a UIF view, field id or property name
031 *
032 * @author Kuali Rice Team (rice.collab@kuali.org)
033 */
034public class ViewFieldPermissionTypeServiceImpl extends PermissionTypeServiceBase {
035
036    @Override
037    protected List<String> getRequiredAttributes() {
038        List<String> attributes = new ArrayList<String>(super.getRequiredAttributes());
039        attributes.add(KimConstants.AttributeConstants.VIEW_ID);
040
041        return Collections.unmodifiableList(attributes);
042    }
043
044    /**
045     * Filters the given permission list to return those that match on field id or property name, then calls super
046     * to filter based on view id
047     *
048     * @param requestedDetails - map of details requested with permission (used for matching)
049     * @param permissionsList - list of permissions to process for matches
050     * @return List<Permission> list of permissions that match the requested details
051     */
052    @Override
053    protected List<Permission> performPermissionMatches(Map<String, String> requestedDetails,
054            List<Permission> permissionsList) {
055
056        String requestedFieldId = null;
057        if (requestedDetails.containsKey(KimConstants.AttributeConstants.FIELD_ID)) {
058            requestedFieldId = requestedDetails.get(KimConstants.AttributeConstants.FIELD_ID);
059        }
060
061        String requestedPropertyName = null;
062        if (requestedDetails.containsKey(KimConstants.AttributeConstants.PROPERTY_NAME)) {
063            requestedPropertyName = requestedDetails.get(KimConstants.AttributeConstants.PROPERTY_NAME);
064        }
065
066        List<Permission> matchingPermissions = new ArrayList<Permission>();
067        for (Permission permission : permissionsList) {
068            PermissionBo bo = PermissionBo.from(permission);
069
070            String permissionFieldId = null;
071            if (bo.getDetails().containsKey(KimConstants.AttributeConstants.FIELD_ID)) {
072                permissionFieldId = bo.getDetails().get(KimConstants.AttributeConstants.FIELD_ID);
073            }
074
075            String permissionPropertyName = null;
076            if (bo.getDetails().containsKey(KimConstants.AttributeConstants.PROPERTY_NAME)) {
077                permissionPropertyName = bo.getDetails().get(KimConstants.AttributeConstants.PROPERTY_NAME);
078            }
079
080            if ((requestedFieldId != null) && (permissionFieldId != null) && StringUtils.equals(requestedFieldId,
081                    permissionFieldId)) {
082                matchingPermissions.add(permission);
083            } else if ((requestedPropertyName != null) && (permissionPropertyName != null) && StringUtils.equals(
084                    requestedPropertyName, permissionPropertyName)) {
085                matchingPermissions.add(permission);
086            }
087        }
088
089        return super.performPermissionMatches(requestedDetails, matchingPermissions);
090    }
091
092}