Replace DOMParser with calls to pool or helper class.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / arp / provider / FileSystemArpRepository.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation
3  * for Advanced Internet Development, Inc. All rights reserved
4  * 
5  * 
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  * 
9  * Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 
12  * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution, if any, must include
15  * the following acknowledgment: "This product includes software developed by
16  * the University Corporation for Advanced Internet Development
17  * <http://www.ucaid.edu> Internet2 Project. Alternately, this acknowledegement
18  * may appear in the software itself, if and wherever such third-party
19  * acknowledgments normally appear.
20  * 
21  * Neither the name of Shibboleth nor the names of its contributors, nor
22  * Internet2, nor the University Corporation for Advanced Internet Development,
23  * Inc., nor UCAID may be used to endorse or promote products derived from this
24  * software without specific prior written permission. For written permission,
25  * please contact shibboleth@shibboleth.org
26  * 
27  * Products derived from this software may not be called Shibboleth, Internet2,
28  * UCAID, or the University Corporation for Advanced Internet Development, nor
29  * may Shibboleth appear in their name, without prior written permission of the
30  * University Corporation for Advanced Internet Development.
31  * 
32  * 
33  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
34  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
36  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
37  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
38  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
39  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY
40  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
41  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
45  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46  */
47
48 package edu.internet2.middleware.shibboleth.aa.arp.provider;
49
50 import java.io.File;
51 import java.io.IOException;
52 import java.security.Principal;
53
54 import org.apache.log4j.Logger;
55 import org.w3c.dom.Element;
56 import org.w3c.dom.Node;
57 import org.w3c.dom.NodeList;
58 import org.xml.sax.InputSource;
59 import org.xml.sax.SAXException;
60 import edu.internet2.middleware.shibboleth.aa.arp.Arp;
61 import edu.internet2.middleware.shibboleth.aa.arp.ArpRepository;
62 import edu.internet2.middleware.shibboleth.aa.arp.ArpRepositoryException;
63 import edu.internet2.middleware.shibboleth.common.ShibResource;
64 import edu.internet2.middleware.shibboleth.common.ShibbolethOriginConfig;
65 import edu.internet2.middleware.shibboleth.xml.Parser;
66
67 /**
68  * Simple <code>ArpRepository</code> implementation that uses a filesystem
69  * for storage.
70  * 
71  * @author Walter Hoehn (wassa@columbia.edu)
72  */
73
74 public class FileSystemArpRepository extends BaseArpRepository implements ArpRepository {
75
76         private static Logger log = Logger.getLogger(FileSystemArpRepository.class.getName());
77         private final String siteArpFileName = "arp.site.xml";
78
79         private String dataStorePath;
80
81         public FileSystemArpRepository(Element config) throws ArpRepositoryException {
82                 super(config);
83
84                 NodeList itemElements = config.getElementsByTagNameNS(ShibbolethOriginConfig.originConfigNamespace, "Path");
85
86                 if (itemElements.getLength() > 1) {
87                         log.warn(
88                                 "Encountered multiple <Path> configuration elements for the File System ARP Repository.  Using first...");
89                 }
90                 Node tnode = itemElements.item(0).getFirstChild();
91                 String path = null;
92                 if (tnode != null && tnode.getNodeType() == Node.TEXT_NODE) {
93                         path = tnode.getNodeValue();
94                 }
95                 if (path == null || path.equals("")) {
96                         log.error("ARP repository path not specified.");
97                         throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository: <ArpRepository> element must contain a <Path> element.");
98                 }
99
100                 try {
101                         File realPath = new ShibResource(path, this.getClass()).getFile();
102
103                         if (!realPath.isDirectory()) {
104                                 log.error(
105                                         "Cannot initialize FileSystemArpRepository: specified path is not a directory: ("
106                                                 + realPath.getPath()
107                                                 + ").");
108                                 throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository");
109                         }
110
111                         dataStorePath = path;
112                         if (!dataStorePath.endsWith("/")) {
113                                 dataStorePath += "/";
114                         }
115                         log.info("Initializing File System Arp Repository with a root of (" + dataStorePath + ").");
116                 } catch (Exception e) {
117                         log.error("Cannot initialize FileSystemArpRepository: error accessing path: (" + path + "): " + e);
118                         throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository");
119                 }
120         }
121         /**
122          * @see edu.internet2.middleware.shibboleth.aa.arp.ArpRepository#remove(Arp)
123          */
124         public void remove(Arp arp) throws ArpRepositoryException {
125                 throw new ArpRepositoryException("Remove not implemented for FileSystemArpRepository.");
126         }
127
128         /**
129          * @see edu.internet2.middleware.shibboleth.aa.arp.ArpRepository#update(Arp)
130          */
131         public void update(Arp arp) throws ArpRepositoryException {
132                 throw new ArpRepositoryException("Update not implemented for FileSystemArpRepository.");
133         }
134
135         /**
136          * @see edu.internet2.middleware.shibboleth.aa.arp.provider.BaseArpRepository#retrieveSiteArpXml()
137          */
138         protected Element retrieveSiteArpXml() throws IOException, SAXException {
139
140                 String fileName = dataStorePath + siteArpFileName;
141                 log.debug("Attempting to load site ARP from: (" + fileName + ").");
142                 return retrieveArpXml(fileName);
143
144         }
145
146         private Element retrieveArpXml(String fileName) throws SAXException, IOException {
147
148                 try {
149                         ShibResource resource = new ShibResource(fileName, this.getClass());
150                         if (!resource.getFile().exists()) {
151                                 log.debug("No ARP found.");
152                                 return null;
153                         }
154
155                         Parser.DOMParser parser = new Parser.DOMParser(true);
156                         parser.parse(new InputSource(resource.getInputStream()));
157                         return parser.getDocument().getDocumentElement();
158
159                 } catch (ShibResource.ResourceNotAvailableException e) {
160                         log.debug("No ARP found.");
161                         return null;
162                 }
163         }
164         /**
165          * @see edu.internet2.middleware.shibboleth.aa.arp.provider.BaseArpRepository#retrieveUserArpXml(Principal)
166          */
167         protected Element retrieveUserArpXml(Principal principal) throws IOException, SAXException {
168                 String fileName = dataStorePath + "arp.user." + principal.getName() + ".xml";
169                 log.debug("Attempting to load user (" + principal.getName() + ") ARP from: (" + fileName + ").");
170                 return retrieveArpXml(fileName);
171         }
172
173 }