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