adaa308f9859af01ed47ce531de03d742fcbef3e
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / arp / provider / FileSystemArpRepository.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.arp.provider;
51
52 import java.io.File;
53 import java.io.IOException;
54 import java.security.Principal;
55 import java.util.Properties;
56
57 import org.apache.log4j.Logger;
58 import org.apache.xerces.parsers.DOMParser;
59 import org.w3c.dom.Element;
60 import org.xml.sax.InputSource;
61 import org.xml.sax.SAXException;
62
63 import edu.internet2.middleware.shibboleth.aa.arp.Arp;
64 import edu.internet2.middleware.shibboleth.aa.arp.ArpRepository;
65 import edu.internet2.middleware.shibboleth.aa.arp.ArpRepositoryException;
66 import edu.internet2.middleware.shibboleth.common.ShibResource;
67
68 /**
69  * Simple <code>ArpRepository</code> implementation that uses a filesystem 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(Properties props) throws ArpRepositoryException {
82                 super(props);
83                 if (props
84                         .getProperty(
85                                 "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path",
86                                 null)
87                         == null) {
88                         log.error(
89                                 "Cannot initialize FileSystemArpRepository: attribute (edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path) not specified");
90                         throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository");
91                 }
92
93                 try {
94                         File givenPath =
95                                 new ShibResource(
96                                         props.getProperty(
97                                                 "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path"),
98                                         this.getClass())
99                                         .getFile();
100
101                         if (!givenPath.isDirectory()) {
102                                 log.error(
103                                         "Cannot initialize FileSystemArpRepository: specified path is not a directory: ("
104                                                 + givenPath.getPath()
105                                                 + ").");
106                                 throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository");
107                         }
108
109                         dataStorePath =
110                                 props.getProperty(
111                                         "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.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(
118                                 "Cannot initialize FileSystemArpRepository: error accessing path: ("
119                                         + props.getProperty(
120                                                 "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path")
121                                         + "): "
122                                         + e);
123                         throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository");
124                 }
125         }
126         /**
127          * @see edu.internet2.middleware.shibboleth.aa.arp.ArpRepository#remove(Arp)
128          */
129         public void remove(Arp arp) throws ArpRepositoryException {
130                 throw new ArpRepositoryException("Remove not implemented for FileSystemArpRepository.");
131         }
132
133         /**
134          * @see edu.internet2.middleware.shibboleth.aa.arp.ArpRepository#update(Arp)
135          */
136         public void update(Arp arp) throws ArpRepositoryException {
137                 throw new ArpRepositoryException("Update not implemented for FileSystemArpRepository.");
138         }
139
140         /**
141          * @see edu.internet2.middleware.shibboleth.aa.arp.provider.BaseArpRepository#retrieveSiteArpXml()
142          */
143         protected Element retrieveSiteArpXml() throws IOException, SAXException {
144
145                 String fileName = dataStorePath + siteArpFileName;
146                 log.debug("Attempting to load site ARP from: (" + fileName + ").");
147                 return retrieveArpXml(fileName);
148
149         }
150
151         private Element retrieveArpXml(String fileName) throws SAXException, IOException {
152
153                 try {
154                         ShibResource resource = new ShibResource(fileName, this.getClass());
155                         if (!resource.getFile().exists()) {
156                                 log.debug("No ARP found.");
157                                 return null;
158                         }
159
160                         DOMParser parser = new DOMParser();
161                         parser.parse(new InputSource(resource.getInputStream()));
162                         return parser.getDocument().getDocumentElement();
163
164                 } catch (ShibResource.ResourceNotAvailableException e) {
165                         log.debug("No ARP found.");
166                         return null;
167                 }
168         }
169         /**
170          * @see edu.internet2.middleware.shibboleth.aa.arp.provider.BaseArpRepository#retrieveUserArpXml(Principal)
171          */
172         protected Element retrieveUserArpXml(Principal principal) throws IOException, SAXException {
173                 String fileName =
174                         dataStorePath
175                                 + "arp.user."
176                                 + principal.getName()
177                                 + ".xml";
178                 log.debug(
179                         "Attempting to load user (" + principal.getName() + ") ARP from: (" + fileName + ").");
180                 return retrieveArpXml(fileName);
181         }
182
183 }