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.resolver; 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 service that resolves the attributes for a particular subject. 26 * 27 * @param <RequestContextType> the type of attribute request context used by the resolver. 28 */ 29 public interface AttributeResolver<RequestContextType extends AttributeRequestContext> { 30 31 /** 32 * Gets all the attributes for a given subject. While an initial attribute producer is given this does not mean 33 * every returned attribute is from that producer. The producer may return information that can be used by data 34 * connectors to contact other producers and retrieve attributes from them. 35 * 36 * @param requestContext the attribute resolution context to use to resolve attributes 37 * 38 * @return the attributes describing the subject 39 * 40 * @throws AttributeResolutionException thrown if there is a problem resolving the attributes for the subject 41 */ 42 public Map<String, BaseAttribute> resolveAttributes(RequestContextType requestContext) 43 throws AttributeResolutionException; 44 45 /** 46 * Check that the Attribute Resolver is in a valid state and ready to begin receiving resolution requests. 47 * 48 * @throws AttributeResolutionException if resolver is in an invalid state 49 */ 50 public void validate() throws AttributeResolutionException; 51 }