Moved inner class to peer so that we can serialize it for Crypto Handle Repository.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / provider / MemoryHandleRepository.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.hs.provider;
51
52 import java.security.Principal;
53 import java.util.HashMap;
54 import java.util.HashSet;
55 import java.util.Iterator;
56 import java.util.Map;
57 import java.util.Properties;
58 import java.util.Set;
59 import java.util.Map.Entry;
60
61 import org.apache.log4j.Logger;
62 import org.doomdark.uuid.UUIDGenerator;
63
64 import edu.internet2.middleware.shibboleth.hs.HandleRepository;
65 import edu.internet2.middleware.shibboleth.hs.HandleRepositoryException;
66
67 /**
68  * <code>HandleRepository</code> implementation that uses a static cache.  This requires
69  * that the HS and AA run in the same JVM.
70  * 
71  * @author Walter Hoehn (wassa@columbia.edu)
72  */
73 public class MemoryHandleRepository extends BaseHandleRepository implements HandleRepository {
74
75         protected HandleCache cache = HandleCache.instance();
76         private static Logger log = Logger.getLogger(MemoryHandleRepository.class.getName());
77
78         public MemoryHandleRepository(Properties properties) throws HandleRepositoryException {
79                 super(properties);
80         }
81
82         /**
83          * @see edu.internet2.middleware.shibboleth.hs.HandleRepository#getHandle(Principal)
84          */
85         public String getHandle(Principal principal) {
86                 String handle = UUIDGenerator.getInstance().generateRandomBasedUUID().toString();
87                 log.debug("Assigning handle (" + handle + ") to principal (" + principal.getName() + ").");
88                 synchronized (cache.handleEntries) {
89                         cache.handleEntries.put(handle, createHandleEntry(principal));
90                 }
91                 return handle;
92         }
93
94         /**
95          * @see edu.internet2.middleware.shibboleth.hs.HandleRepository#getPrincipal(String)
96          */
97         public Principal getPrincipal(String handle) {
98                 synchronized (cache.handleEntries) {
99                         if (!cache.handleEntries.containsKey(handle)) {
100                                 log.debug("Repository does not contain an entry for this Attribute Query Handle.");
101                                 return null;
102                         }
103                 }
104                 HandleEntry handleEntry;
105                 synchronized (cache.handleEntries) {
106                         handleEntry = (HandleEntry) cache.handleEntries.get(handle);
107                 }
108                 if (handleEntry.isExpired()) {
109                         log.debug("Attribute Query Handle is expired.");
110                         synchronized (cache.handleEntries) {
111                                 cache.handleEntries.remove(handle);
112                         }
113                         return null;
114                 } else {
115                         log.debug("Attribute Query Handle recognized.");
116                         return handleEntry.principal;
117                 }
118         }
119 }
120 class HandleCache {
121
122         protected Map handleEntries = new HashMap();
123         private static HandleCache instance;
124         protected MemoryRepositoryCleaner cleaner = new MemoryRepositoryCleaner();
125         private static Logger log = Logger.getLogger(HandleCache.class.getName());
126
127         protected HandleCache() {
128         }
129
130         public static synchronized HandleCache instance() {
131                 if (instance == null) {
132                         instance = new HandleCache();
133                         return instance;
134                 }
135                 return instance;
136         }
137         /**
138         * @see java.lang.Object#finalize()
139         */
140         protected void finalize() throws Throwable {
141                 super.finalize();
142                 synchronized (cleaner) {
143                         cleaner.shutdown = true;
144                         cleaner.interrupt();
145                 }
146         }
147
148         private class MemoryRepositoryCleaner extends Thread {
149
150                 private boolean shutdown = false;
151
152                 public MemoryRepositoryCleaner() {
153                         super();
154                         log.debug("Starting Memory Repository Cleanup Thread.");
155                         start();
156                 }
157
158                 public void run() {
159                         try {
160                                 sleep(1 * 60 * 1000);
161                         } catch (InterruptedException e) {
162                                 log.debug("Memory Repository Cleanup interrupted.");
163                         }
164                         while (true) {
165                                 try {
166                                         if (shutdown) {
167                                                 log.debug("Stopping Memory Repository Cleanup Thread.");
168                                                 return;
169                                         }
170                                         Set needsDeleting = new HashSet();
171                                         synchronized (handleEntries) {
172                                                 Iterator iterator = handleEntries.entrySet().iterator();
173                                                 while (iterator.hasNext()) {
174                                                         Entry entry = (Entry) iterator.next();
175                                                         HandleEntry handleEntry = (HandleEntry) entry.getValue();
176                                                         if (handleEntry.isExpired()) {
177                                                                 needsDeleting.add(entry.getKey());
178                                                         }
179                                                 }
180                                                 //release the lock to be friendly
181                                                 Iterator deleteIterator = needsDeleting.iterator();
182                                                 while (deleteIterator.hasNext()) {
183                                                         synchronized (handleEntries) {
184                                                                 log.debug("Expiring an Attribute Query Handle from the Memory Repository.");
185                                                                 handleEntries.remove(deleteIterator.next());
186                                                         }
187                                                 }
188                                         }
189                                         sleep(1 * 60 * 1000);
190                                 } catch (InterruptedException e) {
191                                         log.debug("Memory Repository Cleanup interrupted.");
192                                 }
193                         }
194                 }
195         }
196
197 }