View Javadoc

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