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