1 /* 2 * Licensed to the University Corporation for Advanced Internet Development, 3 * Inc. (UCAID) under one or more contributor license agreements. See the 4 * NOTICE file distributed with this work for additional information regarding 5 * copyright ownership. The UCAID licenses this file to You under the Apache 6 * License, Version 2.0 (the "License"); you may not use this file except in 7 * compliance with the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 18 package edu.internet2.middleware.shibboleth.common.attribute.filtering; 19 20 import java.util.Map; 21 22 import edu.internet2.middleware.shibboleth.common.attribute.AttributeRequestContext; 23 import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute; 24 25 /** 26 * The engine that applies attribute acceptance policies to a collection of attributes. 27 * 28 * @param <ContextType> type of request context expected by this filtering engine 29 */ 30 public interface AttributeFilteringEngine<ContextType extends AttributeRequestContext> { 31 32 /** 33 * Filters values for the given attribute, removing or allowing attributes per some implementation specific policy. 34 * This filtering process may remove attributes with no values but must not add attributes or attribute values. 35 * 36 * @param attributes attributes to be filtered 37 * @param context attribute request context 38 * 39 * @return the filtered attributes, attribute ID is the key, attribute object is the value 40 * 41 * @throws AttributeFilteringException thrown if there is a problem retrieving or applying the attribute acceptance 42 * policy 43 */ 44 public Map<String, BaseAttribute> filterAttributes(Map<String, BaseAttribute> attributes, ContextType context) 45 throws AttributeFilteringException; 46 }