Unifed NameMapper and HSNameMapper interfaces for use by the new IdPResponder servlet.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / 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.hs.provider;
28
29 import java.io.Serializable;
30
31 import org.apache.log4j.Logger;
32 import org.opensaml.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.BaseNameIdentifierMapping;
38 import edu.internet2.middleware.shibboleth.common.NameIdentifierMappingException;
39
40 /**
41  * Base class for {@link NameIdentifierMapping}implementations that support Shibboleth Attribute Query Handles.
42  * 
43  * @author Walter Hoehn
44  */
45 public abstract class AQHNameIdentifierMapping extends BaseNameIdentifierMapping {
46
47         private static Logger           log                     = Logger.getLogger(AQHNameIdentifierMapping.class.getName());
48         /** Time in seconds for which handles are valid */
49         protected long                          handleTTL       = 1800;
50         protected static QName[]        errorCodes      = {SAMLException.REQUESTER,
51                         new QName(edu.internet2.middleware.shibboleth.common.XML.SHIB_NS, "InvalidHandle")};
52
53         public AQHNameIdentifierMapping(Element config) throws NameIdentifierMappingException {
54                 super(config);
55
56                 String rawTTL = ((Element) config).getAttribute("handleTTL");
57                 try {
58                         if (rawTTL != null && !rawTTL.equals("")) {
59                                 handleTTL = Long.parseLong(rawTTL);
60                                 if (handleTTL < 30) {
61                                         log.warn("You have set the Attribute Query Handle \"Time To Live\' to a very low "
62                                                         + "value.  It is recommended that you increase it.");
63                                 }
64                         }
65                         log.debug("Attribute Query Handle TTL set to (" + handleTTL + ") milliseconds.");
66
67                 } catch (NumberFormatException nfe) {
68                         log.error("Value for attribute \"handleTTL\" mus be a long integer.");
69                         throw new NameIdentifierMappingException("Could not load Name Identifier Mapping with configured data.");
70                 }
71         }
72
73         protected HandleEntry createHandleEntry(AuthNPrincipal principal) {
74                 return new HandleEntry(principal, handleTTL);
75         }
76 }
77
78 class HandleEntry implements Serializable {
79
80         static final long                       serialVersionUID        = 1L;
81         protected AuthNPrincipal        principal;
82         protected long                          expirationTime;
83
84         /**
85          * Creates a HandleEntry
86          * 
87          * @param principal
88          *            the principal represented by this entry.
89          * @param TTL
90          *            the time, in seconds, for which the handle should be valid.
91          */
92         protected HandleEntry(AuthNPrincipal principal, long TTL) {
93                 this.principal = principal;
94                 expirationTime = System.currentTimeMillis() + (TTL * 1000);
95         }
96
97         protected boolean isExpired() {
98                 return (System.currentTimeMillis() > expirationTime);
99         }
100 }