View Javadoc

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;
19  
20  import java.util.Map;
21  
22  /**
23   * Interface for an attribute authority. An attribute authority will pull attribute information for the principal
24   * specified in the request context. If no principal is specified it is assumed that the authority implementation will
25   * be able to derive the principal from other data within the request context.
26   * 
27   * @param <ContextType> contextual information expected by the attribute authority
28   */
29  public interface AttributeAuthority<ContextType extends AttributeRequestContext> {
30  
31      /**
32       * Gets the attributes for the principal identified in the request.
33       * 
34       * @param requestContext contextual information for the attribute request
35       * 
36       * @return the request attributes keyed by the attributes' IDs.
37       * 
38       * @throws AttributeRequestException thrown if there is a problem retrieving the attributes
39       */
40      public Map<String, BaseAttribute> getAttributes(ContextType requestContext)
41              throws AttributeRequestException;
42  }