More guts in the Name Mapping code.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / provider / BaseHandleRepository.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.io.Serializable;
53 import java.util.Properties;
54
55 import org.apache.log4j.Logger;
56
57 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
58 import edu.internet2.middleware.shibboleth.hs.HandleRepository;
59 import edu.internet2.middleware.shibboleth.hs.HandleRepositoryException;
60
61 /**
62  * <code>HandleRepository</code> shared implementation code.
63  * 
64  * @author Walter Hoehn (wassa@columbia.edu)
65  */
66 public abstract class BaseHandleRepository implements HandleRepository {
67         
68         /** Time in seconds for which handles are valid */
69         protected long handleTTL = 1800;
70         private static Logger log = Logger.getLogger(BaseHandleRepository.class.getName());
71
72         protected BaseHandleRepository(Properties properties) throws HandleRepositoryException {
73                 try {
74                         if (properties.getProperty("edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL")
75                                 != null) {
76                                 handleTTL =
77                                         Long.parseLong(
78                                                 properties.getProperty(
79                                                         "edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL",
80                                                         null));
81                                 if (handleTTL < 30) {
82                                         log.warn(
83                                                 "You have set the Attribute Query Handle \"Time To Live\' to a very low "
84                                                         + "value.  It is recommended that you increase it.");
85                                 }
86                         }
87                         log.debug("Attribute Query Handle TTL set to (" + handleTTL + ") milliseconds.");
88
89                 } catch (NumberFormatException nfe) {
90                         log.error(
91                                 "Value for (edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL) must be a long integer.");
92                         throw new HandleRepositoryException("Value for (edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL) must be a long integer.");
93                 }
94         }
95         
96         protected HandleEntry createHandleEntry(AuthNPrincipal principal) {
97                 return new HandleEntry(principal, handleTTL);
98         }
99                 
100                 
101                 
102 }
103
104 class HandleEntry implements Serializable {
105
106         static final long serialVersionUID = 1L;
107         protected AuthNPrincipal principal;
108         protected long expirationTime;
109
110         /**
111          * Creates a HandleEntry
112          * @param principal the principal represented by this entry.
113          * @param TTL the time, in seconds, for which the handle should be valid.
114          */
115         protected HandleEntry(AuthNPrincipal principal, long TTL) {
116                 this.principal = principal;
117                 expirationTime = System.currentTimeMillis() + (TTL * 1000);
118         }
119
120         protected boolean isExpired() {
121                 return (System.currentTimeMillis() > expirationTime);
122         }
123 }