Import the eAuth subject plugin into HEAD.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / HSNameMapper.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation
3  * for Advanced Internet Development, Inc. All rights reserved
4  * 
5  * 
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  * 
9  * Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 
12  * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution, if any, must include
15  * the following acknowledgment: "This product includes software developed by
16  * the University Corporation for Advanced Internet Development
17  * <http://www.ucaid.edu> Internet2 Project. Alternately, this acknowledegement
18  * may appear in the software itself, if and wherever such third-party
19  * acknowledgments normally appear.
20  * 
21  * Neither the name of Shibboleth nor the names of its contributors, nor
22  * Internet2, nor the University Corporation for Advanced Internet Development,
23  * Inc., nor UCAID may be used to endorse or promote products derived from this
24  * software without specific prior written permission. For written permission,
25  * please contact shibboleth@shibboleth.org
26  * 
27  * Products derived from this software may not be called Shibboleth, Internet2,
28  * UCAID, or the University Corporation for Advanced Internet Development, nor
29  * may Shibboleth appear in their name, without prior written permission of the
30  * University Corporation for Advanced Internet Development.
31  * 
32  * 
33  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
34  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
36  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
37  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
38  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
39  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY
40  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
41  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
45  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46  */
47 package edu.internet2.middleware.shibboleth.hs;
48
49 import java.util.HashMap;
50 import java.util.Iterator;
51 import java.util.Map;
52
53 import org.opensaml.SAMLNameIdentifier;
54
55 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
56 import edu.internet2.middleware.shibboleth.common.IdentityProvider;
57 import edu.internet2.middleware.shibboleth.common.NameIdentifierMapping;
58 import edu.internet2.middleware.shibboleth.common.NameIdentifierMappingException;
59 import edu.internet2.middleware.shibboleth.common.NameMapper;
60 import edu.internet2.middleware.shibboleth.common.ServiceProvider;
61
62 /**
63  * <code>NameMapper</code> that additionally maps local <code>AuthNPrincipal</code>
64  * to SAML Name Identifiers. Mappings can be associated with a <code>String</code>
65  * id and recovered based on the same.
66  * 
67  * @author Walter Hoehn
68  * @see NameMapper
69  * @see HSNameIdentifierMapping
70  */
71 public class HSNameMapper extends NameMapper {
72
73         private Map byId = new HashMap();
74
75         /**
76          * Adds a <code>NameIdentifierMapping</code> to this <code>HSNameMapper</code>,
77          * registering it according to its format and, if applicable, according to
78          * its id.
79          * 
80          * @param mapping
81          *            the mapping to add
82          */
83         public void addNameMapping(NameIdentifierMapping mapping) {
84                 super.addNameMapping(mapping);
85                 if (mapping instanceof HSNameIdentifierMapping) {
86                         if (((HSNameIdentifierMapping) mapping).getId() != null
87                                 && (!((HSNameIdentifierMapping) mapping).getId().equals(""))) {
88                                 byId.put(((HSNameIdentifierMapping) mapping).getId(), mapping);
89                         }
90                 }
91         }
92
93         /**
94          * Returns the <code>HSNameIdentifierMapping</code> registered for a
95          * given id
96          * 
97          * @param id
98          *            the registered id
99          * @return the mapping or <tt>null</tt> if no mapping is registered for
100          *         the given id
101          */
102         public HSNameIdentifierMapping getNameIdentifierMappingById(String id) {
103
104                 if (id == null || id.equals("")) {
105                         if (!initialized) {
106                                 return defaultMapping;
107                         }
108
109                         if (byFormat.size() == 1) {
110                                 Iterator values = byFormat.values().iterator();
111                                 Object mapping = values.next();
112                                 if (mapping instanceof HSNameIdentifierMapping) {
113                                         return (HSNameIdentifierMapping) mapping;
114                                 }
115                         }
116                 }
117
118                 return (HSNameIdentifierMapping) byId.get(id);
119         }
120
121         /**
122          * 
123          * Maps a local principal to a SAML Name Identifier using the mapping registered under a given id.
124          * 
125          * @param id
126          *            the id under which the effective <code>HSNameIdentifierMapping</code>
127          *            is registered
128          * @param principal
129          *            the principal to map
130          * @param sProv
131          *            the provider initiating the request
132          * @param idProv
133          *            the provider handling the request
134          * @return @throws
135          *         NameIdentifierMappingException If the <code>NameMapper</code>
136          *         encounters an internal error
137          */
138         public SAMLNameIdentifier getNameIdentifierName(
139                 String id,
140                 AuthNPrincipal principal,
141                 ServiceProvider sProv,
142                 IdentityProvider idProv)
143                 throws NameIdentifierMappingException {
144
145                 HSNameIdentifierMapping mapping = getNameIdentifierMappingById(id);
146
147                 if (mapping == null) {
148                         throw new NameIdentifierMappingException("Name Identifier id not registered.");
149                 }
150                 return mapping.getNameIdentifierName(principal, sProv, idProv);
151         }
152 }