8c6b4053c66076822520f8fa0638c661c689eb24
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / provider / CustomDataConnector.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
54 import javax.naming.directory.Attributes;
55
56 import org.apache.log4j.Logger;
57 import org.w3c.dom.Element;
58
59 import edu.internet2.middleware.shibboleth.aa.attrresolv.DataConnectorPlugIn;
60 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugInException;
61
62 /**
63  * 
64  * Wrapper class for custom <code>DataConnectorPlugIn</code> implementations.
65  * 
66  * @author Walter Hoehn (wassa@columbia.edu)
67  *
68  */
69 public class CustomDataConnector implements DataConnectorPlugIn {
70
71         private static Logger log = Logger.getLogger(CustomDataConnector.class.getName());
72         private DataConnectorPlugIn custom;
73
74         public CustomDataConnector(Element e) throws ResolutionPlugInException {
75                 if (!e.getTagName().equals("CustomDataConnector")) {
76                         log.error("Incorrect connector configuration: expected <CustomDataConnector> .");
77                         throw new ResolutionPlugInException("Failed to initialize Connector PlugIn.");
78                 }
79
80                 String className = e.getAttribute("class");
81                 if (className == null || className.equals("")) {
82                         log.error("Custom Data Connector requires specification of attributes \"class\".");
83                         throw new ResolutionPlugInException("Failed to initialize Connector PlugIn.");
84                 } else {
85                         try {
86                                 Class[] params = { Class.forName("org.w3c.dom.Element"), };
87                                 Object[] passElement = { e };
88                                 custom = (DataConnectorPlugIn) Class.forName(className).getConstructor(params).newInstance(passElement);
89                         } catch (Exception loaderException) {
90                                 log.error(
91                                         "Failed to load Custom Connector PlugIn implementation class: " + loaderException.getMessage());
92                                 throw new ResolutionPlugInException("Failed to initialize Connector PlugIn.");
93                         }
94                 }
95         }
96
97         /**
98          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.DataConnectorPlugIn#resolve(Principal)
99          */
100         public Attributes resolve(Principal principal) throws ResolutionPlugInException {
101                 return custom.resolve(principal);
102         }
103
104         /**
105          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.BaseResolutionPlugIn#getId()
106          */
107         public String getId() {
108                 return custom.getId();
109         }
110
111         /**
112          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.provider.BaseResolutionPlugIn#getTTL()
113          */
114         public long getTTL() {
115                 return custom.getTTL();
116         }
117
118 }