78b67260162547d9ca93b9561938b51dd30d6d32
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / AttributeDefinitionPlugIn.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.aa.attrresolv;
51
52 import java.security.Principal;
53
54 /**
55  * Defines an Attribute Definition PlugIn for the AA Attribute Resolver.  Such plugins can
56  * be realized at runtime by the resolver and subsequently resolved in conjunction with other
57  * dependant plugins.
58  * 
59  * @author Walter Hoehn (wassa@columbia.edu)
60  */
61
62 public interface AttributeDefinitionPlugIn extends ResolutionPlugIn {
63
64         /**
65          * Resolves the values of an attribute.
66          * 
67          * @param attribute The attribute to be resolved
68          * @param principal The principal for which the attribute should be resolved
69          * @param requester The name of the entity making the resolution request
70          * @param depends Resolution dependencies
71          * @throws ResolutionPlugInException
72          */
73         public void resolve(ResolverAttribute attribute, Principal principal, String requester, Dependencies depends)
74                 throws ResolutionPlugInException;
75
76         /**
77          * Returns an array containing the names of the attribute
78          * definitions that this definition depends upon for resolution. 
79          * 
80          * @return String[] an array of Ids
81          */
82         public String[] getAttributeDefinitionDependencyIds();
83         
84         /**
85          * Returns an array containining the names of the connectors
86          * that this definition depends upon for resolution. 
87          * 
88          * @return String[] an array of Ids
89          */
90         public String[] getDataConnectorDependencyIds();
91 }