Import of attribute resolver code.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / provider / SimpleAttributeDefinition.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.provider;
51
52 import java.security.Principal;
53 import java.util.Arrays;
54 import java.util.HashSet;
55 import java.util.Iterator;
56 import java.util.Set;
57
58 import javax.naming.NamingEnumeration;
59 import javax.naming.NamingException;
60 import javax.naming.directory.Attribute;
61 import javax.naming.directory.Attributes;
62
63 import org.apache.log4j.Logger;
64 import org.w3c.dom.Element;
65
66 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeDefinitionPlugIn;
67 import edu.internet2.middleware.shibboleth.aa.attrresolv.Dependencies;
68 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugInException;
69 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolverAttribute;
70
71 /**
72  * Basic <code>AttributeDefinitionPlugIn</code> implementation.  Operates as a proxy for attributes
73  * gathered by Connectors.
74  * 
75  * @author Walter Hoehn (wassa@columbia.edu)
76  */
77 public class SimpleAttributeDefinition extends BaseAttributeDefinition implements AttributeDefinitionPlugIn {
78
79         private static Logger log = Logger.getLogger(SimpleAttributeDefinition.class.getName());
80         private String connectorMapping;
81         private String smartScope;
82         private String schemaType;
83         private String schemaNamespace;
84         private ValueHandler valueHandler;
85
86         /**
87          * Constructor for SimpleAttributeDefinition.  Creates a PlugIn based on configuration
88          * information presented in a DOM Element.
89          */
90         public SimpleAttributeDefinition(Element e) throws ResolutionPlugInException {
91
92                 super(e);
93
94                 String sourceName = e.getAttribute("sourceName");
95                 if (sourceName == null || sourceName.equals("")) {
96                         connectorMapping = getId().substring(getId().lastIndexOf(":") + 1);
97                 } else {
98                         connectorMapping = sourceName;
99                 }
100
101                 log.debug("Mapping attribute to name (" + connectorMapping + ") in connector.");
102
103                 String smartScopingSpec = e.getAttribute("smartScope");
104                 if (smartScopingSpec != null && !smartScopingSpec.equals("")) {
105                         smartScope = smartScopingSpec;
106                 }
107                 if (smartScope != null) {
108                         log.debug("Smart Scope (" + smartScope + ") enabled for attribute (" + getId() + ").");
109                 } else {
110                         log.debug("Smart Scoping disabled for attribute (" + getId() + ").");
111                 }
112
113                 String valueHandlerSpec = e.getAttribute("valueHandler");
114
115                 if (valueHandlerSpec != null && !valueHandlerSpec.equals("")) {
116                         if (smartScope == null) {
117                                 try {
118                                         Class handlerClass = Class.forName(valueHandlerSpec);
119                                         valueHandler = (ValueHandler) handlerClass.newInstance();
120                                 } catch (ClassNotFoundException cnfe) {
121                                         log.error(
122                                                 "Value Handler implementation specified for attribute ("
123                                                         + getId()
124                                                         + ") cannot be found: "
125                                                         + cnfe);
126                                         throw new ResolutionPlugInException(
127                                                 "Value Handler implementation specified for attribute (" + getId() + ") cannot be found.");
128                                 } catch (Exception oe) {
129                                         log.error(
130                                                 "Value Handler implementation specified for attribute ("
131                                                         + getId()
132                                                         + ") coudl not be loaded: "
133                                                         + oe);
134                                         throw new ResolutionPlugInException(
135                                                 "Value Handler implementation specified for attribute (" + getId() + ") could not be loaded.");
136                                 }
137                         } else {
138                                 log.error(
139                                         "Specification of \"valueHandler\' cannot be used in combination with \"smartScope\".  Ignoring Value Handler for attribute ("
140                                                 + getId()
141                                                 + ").");
142                         }
143                 }
144
145                 if (valueHandler != null) {
146                         log.debug("Custom Value Handler enabled for attribute (" + getId() + ").");
147                 }
148
149         }
150
151         /**
152          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeDefinitionPlugIn#resolve(edu.internet2.middleware.shibboleth.aa.attrresolv.ResolverAttribute, java.security.Principal, java.lang.String, edu.internet2.middleware.shibboleth.aa.attrresolv.Dependencies)
153          */
154         public void resolve(ResolverAttribute attribute, Principal principal, String requester, Dependencies depends)
155                 throws ResolutionPlugInException {
156                 log.debug("Resolving attribute: (" + getId() + ")");
157                 Set results = new HashSet();
158                 if (!connectorDependencyIds.isEmpty()) {
159                         results.addAll(Arrays.asList(getValuesFromConnectors(depends)));
160                 }
161
162                 if (!attributeDependencyIds.isEmpty()) {
163                         results.addAll(Arrays.asList(getValuesFromAttributes(depends)));
164                 }
165
166                 if (lifeTime != -1) {
167                         attribute.setLifetime(lifeTime);
168                 }
169
170                 Iterator resultsIt = results.iterator();
171                 while (resultsIt.hasNext()) {
172                         if (smartScope != null) {
173                                 attribute.registerValueHandler(new ScopedStringValueHandler(smartScope));
174                         }
175                         if (smartScope == null && valueHandler != null) {
176                                 attribute.registerValueHandler(valueHandler);
177                         }
178                         attribute.addValue(resultsIt.next());
179                 }
180                 attribute.setResolved();
181         }
182
183         protected Object[] getValuesFromAttributes(Dependencies depends) {
184
185                 Set results = new HashSet();
186
187                 Iterator attrDependIt = attributeDependencyIds.iterator();
188                 while (attrDependIt.hasNext()) {
189                         ResolverAttribute attribute = depends.getAttributeResolution((String) attrDependIt.next());
190                         if (attribute != null) {
191                                 log.debug("Found value(s) for attribute (" + getId() + ").");
192                                 for (Iterator iterator = attribute.getValues(); iterator.hasNext();) {
193                                         results.add(iterator.next());
194                                 }
195                         } else {
196                                 log.error(
197                                         "An attribute dependency of attribute (" + getId() + ") was not included in the dependency chain.");
198                         }
199                 }
200
201                 if (results.isEmpty()) {
202                         log.debug("An attribute dependency of attribute (" + getId() + ") supplied no values.");
203                 }
204                 return results.toArray();
205         }
206
207         protected Object[] getValuesFromConnectors(Dependencies depends) {
208
209                 Set results = new HashSet();
210
211                 Iterator connectorDependIt = connectorDependencyIds.iterator();
212                 while (connectorDependIt.hasNext()) {
213                         Attributes attrs = depends.getConnectorResolution((String) connectorDependIt.next());
214                         if (attrs != null) {
215                                 Attribute attr = attrs.get(connectorMapping);
216                                 if (attr != null) {
217                                         log.debug("Found value(s) for attribute (" + getId() + ").");
218                                         try {
219                                                 NamingEnumeration valuesEnum = attr.getAll();
220                                                 while (valuesEnum.hasMore()) {
221                                                         results.add(valuesEnum.next());
222                                                 }
223                                         } catch (NamingException e) {
224                                                 log.error(
225                                                         "An problem was encountered resolving the dependencies of attribute ("
226                                                                 + getId()
227                                                                 + "): "
228                                                                 + e);
229                                         }
230                                 }
231                         }
232                 }
233
234                 if (results.isEmpty()) {
235                         log.debug("A connector dependency of attribute (" + getId() + ") supplied no values.");
236                 }
237                 return results.toArray();
238         }
239 }