76a678966418bf1f01d01e9ad4c7294e2ea8f399
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / provider / IdentityHandleRepository.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.Properties;
53
54 import org.apache.log4j.Logger;
55
56 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
57 import edu.internet2.middleware.shibboleth.common.Constants;
58 import edu.internet2.middleware.shibboleth.hs.HandleRepository;
59 import edu.internet2.middleware.shibboleth.hs.HandleRepositoryException;
60 import edu.internet2.middleware.shibboleth.hs.HandleRepositoryFactory;
61 import edu.internet2.middleware.shibboleth.hs.InvalidHandleException;
62
63 /**
64  * <code>HandleRepository</code> implementation that uses principal names as handles
65  * 
66  * @author Scott Cantor (cantor.2@osu.edu)
67  */
68 public class IdentityHandleRepository extends BaseHandleRepository implements HandleRepository {
69
70         private static Logger log = Logger.getLogger(IdentityHandleRepository.class.getName());
71     
72     private String format = null;
73     private HandleRepository generator = null;
74
75         public IdentityHandleRepository(Properties properties) throws HandleRepositoryException {
76                 super(properties);
77         format = properties.getProperty(
78             "edu.internet2.middleware.shibboleth.hs.IdentityHandleRepository.formatURI",
79             Constants.SHIB_NAMEID_FORMAT_URI
80             );
81         String className = properties.getProperty(
82             "edu.internet2.middleware.shibboleth.hs.IdentityHandleRepository.handleGenerator",
83             null
84             );
85         if (className != null) {
86             generator = HandleRepositoryFactory.getInstance(className, properties);
87             log.debug("Handle generation will be implemented by (" + className +  ")");
88         }
89         log.debug("Attribute Query Handle TTL set to (" + handleTTL + ") milliseconds.");
90         }
91
92         /**
93          * @see edu.internet2.middleware.shibboleth.hs.HandleRepository#getHandle(Principal)
94          */
95         public String getHandle(AuthNPrincipal principal, StringBuffer format) throws HandleRepositoryException {
96         //Delegate handle creation?
97         if (generator != null) {
98             return generator.getHandle(principal, format);
99         }
100         
101                 if (principal == null || format == null) {
102                         log.error("A principal and format buffer must be supplied for Attribute Query Handle creation.");
103                         throw new IllegalArgumentException("A principal and format buffer must be supplied for Attribute Query Handle creation.");
104                 }
105
106         format.setLength(0);
107         format.append(this.format);
108
109                 return principal.getName();
110         }
111
112         /**
113          * @see edu.internet2.middleware.shibboleth.hs.HandleRepository#getPrincipal(String)
114          */
115         public AuthNPrincipal getPrincipal(String handle, String format) throws HandleRepositoryException, InvalidHandleException {
116         if (format != null && format.equals(Constants.SHIB_NAMEID_FORMAT_URI)) {
117             return generator.getPrincipal(handle, format);
118         }
119         
120         return new AuthNPrincipal(handle);
121         }
122 }