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