Metadata support for old and new schemas, and API changes.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / common / TargetFederationComponent.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
3  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
4  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
5  * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the
6  * above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other
7  * materials provided with the distribution, if any, must include the following acknowledgment: "This product includes
8  * software developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu>Internet2
9  * Project. Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
10  * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2,
11  * nor the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
12  * products derived from this software without specific prior written permission. For written permission, please
13  * contact shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2,
14  * UCAID, or the University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name,
15  * without prior written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS
16  * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES,
17  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
18  * NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS
19  * WITH LICENSEE. IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED
20  * INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
23  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 package edu.internet2.middleware.shibboleth.common;
28
29 import java.util.ArrayList;
30 import java.util.Iterator;
31
32 import javax.servlet.http.HttpServlet;
33
34 import org.apache.log4j.Logger;
35 import org.opensaml.artifact.Artifact;
36 import org.w3c.dom.Element;
37
38 import edu.internet2.middleware.shibboleth.metadata.Metadata;
39 import edu.internet2.middleware.shibboleth.metadata.MetadataException;
40 import edu.internet2.middleware.shibboleth.metadata.EntityDescriptor;
41
42 /**
43  * @author Walter Hoehn (wassa@columbia.edu)
44  */
45 public class TargetFederationComponent extends HttpServlet implements Metadata {
46
47         private static Logger   log                     = Logger.getLogger(TargetFederationComponent.class.getName());
48
49         private ArrayList               fedMetadata     = new ArrayList();
50
51         protected void addFederationProvider(Element element) {
52                 log.debug("Found Federation Provider configuration element.");
53                 if (!element.getTagName().equals("FederationProvider")) {
54                         log.error("Error while attemtping to load Federation Provider.  Malformed provider specificaion.");
55                         return;
56                 }
57
58                 try {
59                         fedMetadata.add(FederationProviderFactory.loadProvider(element));
60                 } catch (MetadataException e) {
61                         log.error("Unable to load Federation Provider.  Skipping...");
62                 }
63         }
64
65         protected int providerCount() {
66                 return fedMetadata.size();
67         }
68
69         public EntityDescriptor lookup(String providerId) {
70
71                 Iterator iterator = fedMetadata.iterator();
72                 while (iterator.hasNext()) {
73                         EntityDescriptor provider = ((Metadata) iterator.next()).lookup(providerId);
74                         if (provider != null) {
75                                 return provider;
76                         }
77                 }
78                 return null;
79         }
80
81     public EntityDescriptor lookup(Artifact artifact) {
82         Iterator iterator = fedMetadata.iterator();
83         while (iterator.hasNext()) {
84             EntityDescriptor provider = ((Metadata) iterator.next()).lookup(artifact);
85             if (provider != null) {
86                 return provider;
87             }
88         }
89         return null;
90     }
91 }
92
93 class FederationProviderFactory {
94
95         private static Logger   log     = Logger.getLogger(FederationProviderFactory.class.getName());
96
97         public static Metadata loadProvider(Element e) throws MetadataException {
98
99                 String className = e.getAttribute("type");
100                 if (className == null || className.equals("")) {
101                         log.error("Federation Provider requires specification of the attribute \"type\".");
102                         throw new MetadataException("Failed to initialize Federation Provider.");
103                 } else {
104                         try {
105                                 Class[] params = {Class.forName("org.w3c.dom.Element"),};
106                                 return (Metadata) Class.forName(className).getConstructor(params).newInstance(new Object[]{e});
107                         } catch (Exception loaderException) {
108                                 log.error("Failed to load Federation Provider implementation class: " + loaderException);
109                 Throwable cause = loaderException.getCause();
110                 while (cause != null) {
111                                         log.error("caused by: " + cause);
112                     cause = cause.getCause();
113                 }
114                                 throw new MetadataException("Failed to initialize Federation Provider.");
115                         }
116                 }
117         }
118 }