View Javadoc

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