Retain order of attribute and connector dependencies as a part of the dependency...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / provider / BaseResolutionPlugIn.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.util.LinkedHashSet;
53 import java.util.Set;
54
55 import org.apache.log4j.Logger;
56 import org.w3c.dom.Element;
57 import org.w3c.dom.NodeList;
58
59 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver;
60 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugIn;
61 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugInException;
62
63 /**
64  * Base class for Resolution PlugIns, both <code>AttributeDefinitionPlugIn</code> & <code>DataConnectorPlugIn</code>
65  * 
66  * @author Walter Hoehn (wassa@columbia.edu)
67  */
68
69 public abstract class BaseResolutionPlugIn implements ResolutionPlugIn {
70
71         private static Logger log = Logger.getLogger(BaseResolutionPlugIn.class.getName());
72         
73         /** The identifier for this PlugIn. */
74         protected String id;
75
76         /** Time, in seconds, for which the Attribute Resolver should cache resolutions of this PlugIn. */
77         protected long ttl = 0;
78     
79     /** Whether to propagate errors out of the PlugIn as exceptions. */
80     protected boolean propagateErrors = true;
81
82     /** Dependencies. */
83     protected Set connectorDependencyIds = new LinkedHashSet();
84     protected Set attributeDependencyIds = new LinkedHashSet();
85
86         protected BaseResolutionPlugIn(Element e) throws ResolutionPlugInException {
87                 String id = e.getAttribute("id");
88                 if (id == null || id.equals("")) {
89                         log.error("Attribute \"id\" required to configure plugin.");
90                         throw new ResolutionPlugInException("Failed to initialize Resolution PlugIn.");
91                 }
92                 this.id = id;
93
94                 String cacheTime = e.getAttribute("cacheTime");
95                 if (cacheTime != null && !cacheTime.equals("")) {
96                         try {
97                                 this.ttl = Long.parseLong(cacheTime);
98                         } catch (NumberFormatException nfe) {
99                                 log.error("Attribute \"cacheTime\" must be an integer between 0 and " + Long.MAX_VALUE + ".");
100                                 throw new ResolutionPlugInException("Failed to initialize Resolution PlugIn.");
101                         }
102                 }
103         
104         String propagateFlag = e.getAttribute("propagateErrors");
105         if (propagateFlag != null && (propagateFlag.equals("false") || propagateFlag.equals("0"))) {
106             propagateErrors = false;
107         }
108
109         NodeList connectorNodes = e.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "DataConnectorDependency");
110
111         for (int i = 0; connectorNodes.getLength() > i; i++) {
112             Element connector = (Element) connectorNodes.item(i);
113             String connectorName = connector.getAttribute("requires");
114             if (connectorName != null && !connectorName.equals("")) {
115                 addDataConnectorDependencyId(connectorName);
116             } else {
117                 log.error("Data Connector dependency must be accompanied by a \"requires\" attribute.");
118                 throw new ResolutionPlugInException("Failed to initialize Resolution PlugIn.");
119             }
120         }
121
122         NodeList attributeNodes = e.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "AttributeDependency");
123         for (int i = 0; attributeNodes.getLength() > i; i++) {
124             Element attribute = (Element) attributeNodes.item(i);
125             String attributeName = attribute.getAttribute("requires");
126             if (attributeName != null && !attributeName.equals("")) {
127                 addAttributeDefinitionDependencyId(attributeName);
128             } else {
129                 log.error("Attribute Definition dependency must be accompanied by a \"requires\" attribute.");
130                 throw new ResolutionPlugInException("Failed to initialize Resolution PlugIn.");
131             }
132         }
133         }
134         
135         /** Returns the identifier for this PlugIn. */
136         public String getId() {
137                 return id;
138         }
139
140         /** Returns the time, in seconds, for which the Attribute Resolver should cache resolutions of this PlugIn. */
141         public long getTTL() {
142                 return ttl;
143         }
144
145     /**
146      * @see edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugIn#getPropagateErrors()
147      */
148     public boolean getPropagateErrors() {
149         return propagateErrors;
150     }
151
152
153     protected void addDataConnectorDependencyId(String id) {
154         connectorDependencyIds.add(id);
155     }
156
157     protected void addAttributeDefinitionDependencyId(String id) {
158         attributeDependencyIds.add(id);
159     }
160
161     /**
162      * @see edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugIn#getAttributeDependencyIds()
163      */
164     public String[] getAttributeDefinitionDependencyIds() {
165         return (String[]) attributeDependencyIds.toArray(new String[0]);
166     }
167
168     /**
169      * @see edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugIn#getConnectorDependencyIds()
170      */
171     public String[] getDataConnectorDependencyIds() {
172         return (String[]) connectorDependencyIds.toArray(new String[0]);
173     }
174 }