f82bcf6a0438f922e8c0bd5c143bbb5579baef62
[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.FileInputStream;
54 import java.io.FileNotFoundException;
55 import java.io.IOException;
56 import java.io.InputStream;
57 import java.security.Principal;
58 import java.util.Properties;
59
60 import org.apache.log4j.Logger;
61 import org.apache.xerces.parsers.DOMParser;
62 import org.w3c.dom.Element;
63 import org.xml.sax.InputSource;
64 import org.xml.sax.SAXException;
65
66 import edu.internet2.middleware.shibboleth.aa.arp.Arp;
67 import edu.internet2.middleware.shibboleth.aa.arp.ArpRepository;
68 import edu.internet2.middleware.shibboleth.aa.arp.ArpRepositoryException;
69
70 /**
71  * Simple <code>ArpRepository</code> implementation that uses a filesystem for storage.
72  * 
73  * @author Walter Hoehn (wassa@columbia.edu)
74  */
75
76 public class FileSystemArpRepository extends BaseArpRepository implements ArpRepository {
77
78         private static Logger log = Logger.getLogger(FileSystemArpRepository.class.getName());
79         private final String siteArpFileName = "arp.site.xml";
80
81         private String dataStorePath;
82
83         public FileSystemArpRepository(Properties props) throws ArpRepositoryException {
84                 super(props);
85                 if (props
86                         .getProperty(
87                                 "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path",
88                                 null)
89                         == null) {
90                         log.error(
91                                 "Cannot initialize FileSystemArpRepository: attribute (edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path) not specified");
92                         throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository");
93                 }
94
95                 File givenPath =
96                         new File(
97                                 props.getProperty(
98                                         "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path"));
99                 if (!givenPath.isDirectory()) {
100                         log.error(
101                                 "Cannot initialize FileSystemArpRepository: specified path is not a directory.");
102                         throw new ArpRepositoryException("Cannot initialize FileSystemArpRepository");
103                 }
104
105                 log.info(
106                         "Initializing File System Arp Repository with a root of ("
107                                 + givenPath.getAbsolutePath()
108                                 + ").");
109                 dataStorePath =
110                         props.getProperty(
111                                 "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path");
112         }
113
114         /**
115          * @see edu.internet2.middleware.shibboleth.aa.arp.ArpRepository#remove(Arp)
116          */
117         public void remove(Arp arp) throws ArpRepositoryException {
118                 throw new ArpRepositoryException("Remove not implemented for FileSystemArpRepository.");
119         }
120
121         /**
122          * @see edu.internet2.middleware.shibboleth.aa.arp.ArpRepository#update(Arp)
123          */
124         public void update(Arp arp) throws ArpRepositoryException {
125                 throw new ArpRepositoryException("Update not implemented for FileSystemArpRepository.");
126         }
127
128         /**
129          * @see edu.internet2.middleware.shibboleth.aa.arp.provider.BaseArpRepository#retrieveSiteArpXml()
130          */
131         protected Element retrieveSiteArpXml() throws IOException, SAXException {
132
133                 String fileName = dataStorePath + System.getProperty("file.separator") + siteArpFileName;
134                 log.debug("Attempting to load site ARP from: (" + fileName + ").");
135                 return retrieveArpXml(fileName);
136
137         }
138
139         private Element retrieveArpXml(String fileName)
140                 throws FileNotFoundException, SAXException, IOException {
141
142                 File arpFile = new File(fileName);
143                 if (!arpFile.exists()) {
144                         log.debug("No ARP found.");
145                         return null;
146                 }
147
148                 InputStream inStream = new FileInputStream(fileName);
149                 DOMParser parser = new DOMParser();
150                 parser.parse(new InputSource(inStream));
151                 return parser.getDocument().getDocumentElement();
152         }
153
154         /**
155          * @see edu.internet2.middleware.shibboleth.aa.arp.provider.BaseArpRepository#retrieveUserArpXml(Principal)
156          */
157         protected Element retrieveUserArpXml(Principal principal) throws IOException, SAXException {
158                 String fileName =
159                         dataStorePath
160                                 + System.getProperty("file.separator")
161                                 + "arp.user."
162                                 + principal.getName()
163                                 + ".xml";
164                 log.debug(
165                         "Attempting to load user (" + principal.getName() + ")ARP from: (" + fileName + ").");
166                 return retrieveArpXml(fileName);
167         }
168
169 }