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.provider; 19 20 import java.util.List; 21 22 import edu.internet2.middleware.shibboleth.common.attribute.resolver.AttributeResolutionException; 23 24 /** 25 * A base interface for plugins that provide attributes. 26 * 27 * @param <ResolvedType> object type this plug-in resolves to 28 */ 29 public interface ResolutionPlugIn<ResolvedType> { 30 31 /** 32 * Returns the unique ID of the plugin. 33 * 34 * @return unique ID of the plugin 35 */ 36 public String getId(); 37 38 /** 39 * Gets the IDs of the resolution plugins this plugin is dependent on. 40 * 41 * @return IDs of the data connectors this plugin is dependent on 42 */ 43 public List<String> getDependencyIds(); 44 45 /** 46 * Performs the attribute resolution for this plugin. 47 * 48 * @param resolutionContext the context for the resolution 49 * 50 * @return the attributes made available by the resolution, never null 51 * 52 * @throws AttributeResolutionException the problem that occurred during the resolution 53 */ 54 public ResolvedType resolve(ShibbolethResolutionContext resolutionContext) throws AttributeResolutionException; 55 56 /** 57 * Validate the internal state of this plug-in. This process may not rely on information from any dependency. 58 * 59 * @throws AttributeResolutionException if the plug-in has an invalid internal state 60 */ 61 public void validate() throws AttributeResolutionException; 62 }