de84609a9684750acf7874aed01280a9a09247ba
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / common / provider / AQHNameIdentifierMapping.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
3  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
4  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
5  * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the
6  * above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other
7  * materials provided with the distribution, if any, must include the following acknowledgment: "This product includes
8  * software developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu> Internet2
9  * Project. Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
10  * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2,
11  * nor the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
12  * products derived from this software without specific prior written permission. For written permission, please
13  * contact shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2,
14  * UCAID, or the University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name,
15  * without prior written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS
16  * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES,
17  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
18  * NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS
19  * WITH LICENSEE. IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED
20  * INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
23  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 package edu.internet2.middleware.shibboleth.common.provider;
28
29 import java.io.Serializable;
30
31 import org.apache.log4j.Logger;
32 import javax.xml.namespace.QName;
33 import org.opensaml.SAMLException;
34 import org.w3c.dom.Element;
35
36 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
37 import edu.internet2.middleware.shibboleth.common.NameIdentifierMappingException;
38
39 /**
40  * Base class for {@link NameIdentifierMapping}implementations that support Shibboleth Attribute Query Handles.
41  * 
42  * @author Walter Hoehn
43  */
44 public abstract class AQHNameIdentifierMapping extends BaseNameIdentifierMapping {
45
46         private static Logger           log                     = Logger.getLogger(AQHNameIdentifierMapping.class.getName());
47         /** Time in seconds for which handles are valid */
48         protected long                          handleTTL       = 1800;
49         protected static QName[]        errorCodes      = {SAMLException.REQUESTER,
50                         new QName(edu.internet2.middleware.shibboleth.common.XML.SHIB_NS, "InvalidHandle")};
51
52         public AQHNameIdentifierMapping(Element config) throws NameIdentifierMappingException {
53                 super(config);
54
55                 String rawTTL = ((Element) config).getAttribute("handleTTL");
56                 try {
57                         if (rawTTL != null && !rawTTL.equals("")) {
58                                 handleTTL = Long.parseLong(rawTTL);
59                                 if (handleTTL < 30) {
60                                         log.warn("You have set the Attribute Query Handle \"Time To Live\' to a very low "
61                                                         + "value.  It is recommended that you increase it.");
62                                 }
63                         }
64                         log.debug("Attribute Query Handle TTL set to (" + handleTTL + ") milliseconds.");
65
66                 } catch (NumberFormatException nfe) {
67                         log.error("Value for attribute \"handleTTL\" mus be a long integer.");
68                         throw new NameIdentifierMappingException("Could not load Name Identifier Mapping with configured data.");
69                 }
70         }
71
72         protected HandleEntry createHandleEntry(AuthNPrincipal principal) {
73                 return new HandleEntry(principal, handleTTL);
74         }
75 }
76
77 class HandleEntry implements Serializable {
78
79         static final long                       serialVersionUID        = 1L;
80         protected AuthNPrincipal        principal;
81         protected long                          expirationTime;
82
83         /**
84          * Creates a HandleEntry
85          * 
86          * @param principal
87          *            the principal represented by this entry.
88          * @param TTL
89          *            the time, in seconds, for which the handle should be valid.
90          */
91         protected HandleEntry(AuthNPrincipal principal, long TTL) {
92                 this.principal = principal;
93                 expirationTime = System.currentTimeMillis() + (TTL * 1000);
94         }
95
96         protected boolean isExpired() {
97                 return (System.currentTimeMillis() > expirationTime);
98         }
99 }