Added dependency support to DataConnectors
[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 ValueHandler valueHandler;
83
84         /**
85          * Constructor for SimpleAttributeDefinition.  Creates a PlugIn based on configuration
86          * information presented in a DOM Element.
87          */
88         public SimpleAttributeDefinition(Element e) throws ResolutionPlugInException {
89
90                 super(e);
91
92                 String sourceName = e.getAttribute("sourceName");
93                 if (sourceName == null || sourceName.equals("")) {
94                         int index = getId().lastIndexOf("#");
95                         if (index < 0) {
96                                 index = getId().lastIndexOf(":");
97                                 int slashIndex = getId().lastIndexOf("/");
98                                 if (slashIndex > index) {
99                                         index = slashIndex;
100                                 }
101                         }
102                         connectorMapping = getId().substring(index + 1);
103                 } else {
104                         connectorMapping = sourceName;
105                 }
106
107                 log.debug("Mapping attribute to name (" + connectorMapping + ") in connector.");
108
109                 String smartScopingSpec = e.getAttribute("smartScope");
110                 if (smartScopingSpec != null && !smartScopingSpec.equals("")) {
111                         smartScope = smartScopingSpec;
112                 }
113                 if (smartScope != null) {
114                         log.debug("Smart Scope (" + smartScope + ") enabled for attribute (" + getId() + ").");
115                 } else {
116                         log.debug("Smart Scoping disabled for attribute (" + getId() + ").");
117                 }
118
119                 String valueHandlerSpec = e.getAttribute("valueHandler");
120
121                 if (valueHandlerSpec != null && !valueHandlerSpec.equals("")) {
122                         if (smartScope == null) {
123                                 try {
124                                         Class handlerClass = Class.forName(valueHandlerSpec);
125                                         valueHandler = (ValueHandler) handlerClass.newInstance();
126                                 } catch (ClassNotFoundException cnfe) {
127                                         log.error(
128                                                 "Value Handler implementation specified for attribute ("
129                                                         + getId()
130                                                         + ") cannot be found: "
131                                                         + cnfe);
132                                         throw new ResolutionPlugInException(
133                                                 "Value Handler implementation specified for attribute (" + getId() + ") cannot be found.");
134                                 } catch (Exception oe) {
135                                         log.error(
136                                                 "Value Handler implementation specified for attribute ("
137                                                         + getId()
138                                                         + ") coudl not be loaded: "
139                                                         + oe);
140                                         throw new ResolutionPlugInException(
141                                                 "Value Handler implementation specified for attribute (" + getId() + ") could not be loaded.");
142                                 }
143                         } else {
144                                 log.error(
145                                         "Specification of \"valueHandler\' cannot be used in combination with \"smartScope\".  Ignoring Value Handler for attribute ("
146                                                 + getId()
147                                                 + ").");
148                         }
149                 }
150
151                 if (valueHandler != null) {
152                         log.debug("Custom Value Handler enabled for attribute (" + getId() + ").");
153                 }
154
155         }
156
157         /**
158          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeDefinitionPlugIn#resolve(edu.internet2.middleware.shibboleth.aa.attrresolv.ArpAttribute, java.security.Principal, java.lang.String, edu.internet2.middleware.shibboleth.aa.attrresolv.Dependencies)
159          */
160         public void resolve(ResolverAttribute attribute, Principal principal, String requester, Dependencies depends)
161                 throws ResolutionPlugInException {
162                 log.debug("Resolving attribute: (" + getId() + ")");
163                 Set results = new HashSet();
164                 if (!connectorDependencyIds.isEmpty()) {
165                         results.addAll(Arrays.asList(getValuesFromConnectors(depends)));
166                 }
167
168                 if (!attributeDependencyIds.isEmpty()) {
169                         results.addAll(Arrays.asList(getValuesFromAttributes(depends)));
170                 }
171
172                 if (lifeTime != -1) {
173                         attribute.setLifetime(lifeTime);
174                 }
175
176                 if (smartScope != null) {
177                         attribute.registerValueHandler(new ScopedStringValueHandler(smartScope));
178                 }
179                 if (smartScope == null && valueHandler != null) {
180                         attribute.registerValueHandler(valueHandler);
181                 }
182                 
183                 Iterator resultsIt = results.iterator();
184                 while (resultsIt.hasNext()) {
185                         attribute.addValue(resultsIt.next());
186                 }
187                 attribute.setResolved();
188         }
189
190         protected Object[] getValuesFromAttributes(Dependencies depends) {
191
192                 Set results = new HashSet();
193
194                 Iterator attrDependIt = attributeDependencyIds.iterator();
195                 while (attrDependIt.hasNext()) {
196                         ResolverAttribute attribute = depends.getAttributeResolution((String) attrDependIt.next());
197                         if (attribute != null) {
198                                 log.debug("Found value(s) for attribute (" + getId() + ").");
199                                 for (Iterator iterator = attribute.getValues(); iterator.hasNext();) {
200                                         results.add(iterator.next());
201                                 }
202                         } else {
203                                 log.error(
204                                         "An attribute dependency of attribute (" + getId() + ") was not included in the dependency chain.");
205                         }
206                 }
207
208                 if (results.isEmpty()) {
209                         log.debug("An attribute dependency of attribute (" + getId() + ") supplied no values.");
210                 }
211                 return results.toArray();
212         }
213
214         protected Object[] getValuesFromConnectors(Dependencies depends) {
215
216                 Set results = new HashSet();
217
218                 Iterator connectorDependIt = connectorDependencyIds.iterator();
219                 while (connectorDependIt.hasNext()) {
220                         Attributes attrs = depends.getConnectorResolution((String) connectorDependIt.next());
221                         if (attrs != null) {
222                                 Attribute attr = attrs.get(connectorMapping);
223                                 if (attr != null) {
224                                         log.debug("Found value(s) for attribute (" + getId() + ").");
225                                         try {
226                                                 NamingEnumeration valuesEnum = attr.getAll();
227                                                 while (valuesEnum.hasMore()) {
228                                                         results.add(valuesEnum.next());
229                                                 }
230                                         } catch (NamingException e) {
231                                                 log.error(
232                                                         "An problem was encountered resolving the dependencies of attribute ("
233                                                                 + getId()
234                                                                 + "): "
235                                                                 + e);
236                                         }
237                                 }
238                         }
239                 }
240
241                 if (results.isEmpty()) {
242                         log.debug("A connector dependency of attribute (" + getId() + ") supplied no values.");
243                 }
244                 return results.toArray();
245         }
246 }