Changed arp repository factory so that classes can be plugged in from runtime config.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / ArpFileFactory.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;
51
52 import java.io.File;
53 import java.io.FileInputStream;
54 import java.io.FileNotFoundException;
55 import java.io.FileOutputStream;
56 import java.io.IOException;
57 import java.io.ObjectInput;
58 import java.io.ObjectInputStream;
59 import java.io.ObjectOutput;
60 import java.io.ObjectOutputStream;
61 import java.security.acl.NotOwnerException;
62 import java.util.Date;
63 import java.util.Properties;
64
65 import org.apache.log4j.Logger;
66
67 /**
68  *  Attribute Authority & Release Policy
69  *  File implementation of a repository for ARPs
70  *
71  * @author     Parviz Dousti (dousti@cmu.edu)
72  * @created    June, 2002
73  */
74
75 public class ArpFileFactory implements ArpFactory {
76
77         static String dataStore;
78         private static Logger log = Logger.getLogger(ArpFileFactory.class.getName());
79         public ArpFileFactory(Properties props) {
80                 String pathData = props.getProperty("arpFactoryData");
81                 if (pathData == null) {
82                         String realPath = props.getProperty("arpFactoryRealPath");
83                         realPath += "arps";
84                         log.debug("shib dir = " + realPath);
85                         pathData = realPath;
86                 }
87                 dataStore = pathData;
88         }
89
90         /**
91          * returns an Arp instance. It tries to retrieve the Arp from file system
92          * If not found then creates a new emplty Arp.  
93          * Arp can be check by its isNew() to see how it was generated
94          */
95
96         public Arp getInstance(String arpName, boolean isAdmin) throws AAException {
97                 try {
98
99                         String fileName = dataStore + System.getProperty("file.separator") + arpName;
100                         log.info("AA: Looking for ARP " + fileName);
101
102                         FileInputStream f = new FileInputStream(fileName);
103                         ObjectInput s = new ObjectInputStream(f);
104                         Arp arp = (Arp) s.readObject();
105                         if (!arpName.equals(arp.getName()))
106                                 throw new AAException("Wrong ARP name.  ARP maybe renamed in datastore. ");
107                         arp.setNew(false);
108                         arp.setLastRead(new Date());
109                         log.info("AA: Found and using ARP " + arpName);
110                         return arp;
111
112                 } catch (FileNotFoundException e) {
113                         // check the IO error to make sure "file not found"
114                         log.info("AA: Got File Not Found for " + arpName + " in " + dataStore);
115                         try {
116                                 Arp arp = new Arp(arpName, isAdmin);
117                                 arp.setNew(true);
118                                 arp.setLastRead(new Date());
119                                 return arp;
120                         } catch (NotOwnerException noe) {
121                                 throw new AAException("Cannot create an ARP. Not owner.");
122                         }
123
124                 } catch (IOException fe) {
125                         throw new AAException("Reading ARP failed: " + fe);
126                 } catch (ClassNotFoundException ce) {
127                         throw new AAException("ARP retrival failed: " + ce);
128                 } catch (Exception oe) {
129                         throw new AAException(oe.toString());
130                 }
131         }
132
133         public void write(Arp arp) throws AAException {
134                 // XXX do we need to check any permissions?
135                 try {
136                         String fileName = dataStore + System.getProperty("file.separator") + arp.getName();
137                         FileOutputStream f = new FileOutputStream(fileName);
138                         ObjectOutput s = new ObjectOutputStream(f);
139                         arp.setNew(false);
140                         s.writeObject(arp);
141                         s.flush();
142                 } catch (IOException e) {
143                         throw new AAException("IO Problem:" + e);
144                 }
145         }
146
147         /**
148          * Reread the arp from file system if the copy on disk
149          * is newer than the copy in memory.
150          */
151
152         public Arp reread(Arp arp) throws AAException {
153                 String fileName = dataStore + System.getProperty("file.separator") + arp.getName();
154                 File file = new File(fileName);
155                 if (file == null)
156                         throw new AAException("Arp not found on disk while trying to re-read. :" + arp);
157                 Date timeStamp = new Date(file.lastModified());
158                 log.info(
159                         "AA: Check ARP's freshness: in memory ("
160                                 + arp.getLastRead()
161                                 + ") vs on disk ("
162                                 + timeStamp
163                                 + ")");
164                 if (timeStamp.after(arp.getLastRead())) {
165                         log.info("AA: ARP has been modified on disk. Re-read " + arp.getName());
166                         return getInstance(arp.getName(), arp.isAdmin());
167                 }
168                 return arp; // return the old one.
169         }
170
171         public void remove(Arp arp) throws AAException {
172                 try {
173                         String fileName = dataStore + System.getProperty("file.separator") + arp.getName();
174                         File f = new File(fileName);
175                         f.delete();
176                 } catch (Exception e) {
177                         throw new AAException("IO Problem:" + e);
178                 }
179         }
180
181         public String toString() {
182                 return "ArpFileFactory:dir=" + dataStore;
183         }
184 }