2 * The Shibboleth License, Version 1.
4 * University Corporation for Advanced Internet Development, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * Redistributions of source code must retain the above copyright notice, this
12 * list of conditions and the following disclaimer.
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.
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
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.
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.
50 package edu.internet2.middleware.shibboleth.aa.attrresolv.provider;
52 import java.security.Principal;
53 import java.util.Arrays;
54 import java.util.HashSet;
55 import java.util.Iterator;
58 import javax.naming.NamingEnumeration;
59 import javax.naming.NamingException;
60 import javax.naming.directory.Attribute;
61 import javax.naming.directory.Attributes;
63 import org.apache.log4j.Logger;
64 import org.w3c.dom.Element;
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;
72 * Basic <code>AttributeDefinitionPlugIn</code> implementation. Operates as a proxy for attributes
73 * gathered by Connectors.
75 * @author Walter Hoehn (wassa@columbia.edu)
77 public class SimpleAttributeDefinition extends BaseAttributeDefinition implements AttributeDefinitionPlugIn {
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;
87 * Constructor for SimpleAttributeDefinition. Creates a PlugIn based on configuration
88 * information presented in a DOM Element.
90 public SimpleAttributeDefinition(Element e) throws ResolutionPlugInException {
94 String sourceName = e.getAttribute("sourceName");
95 if (sourceName == null || sourceName.equals("")) {
96 int index = getId().lastIndexOf("#");
98 index = getId().lastIndexOf(":");
99 int slashIndex = getId().lastIndexOf("/");
100 if (slashIndex > index) {
104 connectorMapping = getId().substring(index + 1);
106 connectorMapping = sourceName;
109 log.debug("Mapping attribute to name (" + connectorMapping + ") in connector.");
111 String smartScopingSpec = e.getAttribute("smartScope");
112 if (smartScopingSpec != null && !smartScopingSpec.equals("")) {
113 smartScope = smartScopingSpec;
115 if (smartScope != null) {
116 log.debug("Smart Scope (" + smartScope + ") enabled for attribute (" + getId() + ").");
118 log.debug("Smart Scoping disabled for attribute (" + getId() + ").");
121 String valueHandlerSpec = e.getAttribute("valueHandler");
123 if (valueHandlerSpec != null && !valueHandlerSpec.equals("")) {
124 if (smartScope == null) {
126 Class handlerClass = Class.forName(valueHandlerSpec);
127 valueHandler = (ValueHandler) handlerClass.newInstance();
128 } catch (ClassNotFoundException cnfe) {
130 "Value Handler implementation specified for attribute ("
132 + ") cannot be found: "
134 throw new ResolutionPlugInException(
135 "Value Handler implementation specified for attribute (" + getId() + ") cannot be found.");
136 } catch (Exception oe) {
138 "Value Handler implementation specified for attribute ("
140 + ") coudl not be loaded: "
142 throw new ResolutionPlugInException(
143 "Value Handler implementation specified for attribute (" + getId() + ") could not be loaded.");
147 "Specification of \"valueHandler\' cannot be used in combination with \"smartScope\". Ignoring Value Handler for attribute ("
153 if (valueHandler != null) {
154 log.debug("Custom Value Handler enabled for attribute (" + getId() + ").");
160 * @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)
162 public void resolve(ResolverAttribute attribute, Principal principal, String requester, Dependencies depends)
163 throws ResolutionPlugInException {
164 log.debug("Resolving attribute: (" + getId() + ")");
165 Set results = new HashSet();
166 if (!connectorDependencyIds.isEmpty()) {
167 results.addAll(Arrays.asList(getValuesFromConnectors(depends)));
170 if (!attributeDependencyIds.isEmpty()) {
171 results.addAll(Arrays.asList(getValuesFromAttributes(depends)));
174 if (lifeTime != -1) {
175 attribute.setLifetime(lifeTime);
178 Iterator resultsIt = results.iterator();
179 while (resultsIt.hasNext()) {
180 if (smartScope != null) {
181 attribute.registerValueHandler(new ScopedStringValueHandler(smartScope));
183 if (smartScope == null && valueHandler != null) {
184 attribute.registerValueHandler(valueHandler);
186 attribute.addValue(resultsIt.next());
188 attribute.setResolved();
191 protected Object[] getValuesFromAttributes(Dependencies depends) {
193 Set results = new HashSet();
195 Iterator attrDependIt = attributeDependencyIds.iterator();
196 while (attrDependIt.hasNext()) {
197 ResolverAttribute attribute = depends.getAttributeResolution((String) attrDependIt.next());
198 if (attribute != null) {
199 log.debug("Found value(s) for attribute (" + getId() + ").");
200 for (Iterator iterator = attribute.getValues(); iterator.hasNext();) {
201 results.add(iterator.next());
205 "An attribute dependency of attribute (" + getId() + ") was not included in the dependency chain.");
209 if (results.isEmpty()) {
210 log.debug("An attribute dependency of attribute (" + getId() + ") supplied no values.");
212 return results.toArray();
215 protected Object[] getValuesFromConnectors(Dependencies depends) {
217 Set results = new HashSet();
219 Iterator connectorDependIt = connectorDependencyIds.iterator();
220 while (connectorDependIt.hasNext()) {
221 Attributes attrs = depends.getConnectorResolution((String) connectorDependIt.next());
223 Attribute attr = attrs.get(connectorMapping);
225 log.debug("Found value(s) for attribute (" + getId() + ").");
227 NamingEnumeration valuesEnum = attr.getAll();
228 while (valuesEnum.hasMore()) {
229 results.add(valuesEnum.next());
231 } catch (NamingException e) {
233 "An problem was encountered resolving the dependencies of attribute ("
242 if (results.isEmpty()) {
243 log.debug("A connector dependency of attribute (" + getId() + ") supplied no values.");
245 return results.toArray();