Unifed NameMapper and HSNameMapper interfaces for use by the new IdPResponder servlet.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / provider / PrincipalNameIdentifier.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 above
6  * copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials
7  * provided with the distribution, if any, must include the following acknowledgment: "This product includes software
8  * developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu> Internet2 Project.
9  * 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, nor
11  * 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 contact
13  * shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the
14  * University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name, without prior
15  * written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS PROVIDED BY THE
16  * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE
18  * DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO
19  * EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC.
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
23  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 package edu.internet2.middleware.shibboleth.hs.provider;
27
28 import org.apache.log4j.Logger;
29 import org.opensaml.SAMLException;
30 import org.opensaml.SAMLNameIdentifier;
31 import org.w3c.dom.Element;
32
33 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
34 import edu.internet2.middleware.shibboleth.common.BaseNameIdentifierMapping;
35 import edu.internet2.middleware.shibboleth.common.IdentityProvider;
36 import edu.internet2.middleware.shibboleth.common.InvalidNameIdentifierException;
37 import edu.internet2.middleware.shibboleth.common.NameIdentifierMapping;
38 import edu.internet2.middleware.shibboleth.common.NameIdentifierMappingException;
39 import edu.internet2.middleware.shibboleth.common.ServiceProvider;
40
41 /**
42  * {@link NameIdentifierMapping}implementation to use when the SAML name identifier format matches the Shibboleth
43  * internal representation of the principal.
44  * 
45  * @author Walter Hoehn
46  */
47 public class PrincipalNameIdentifier extends BaseNameIdentifierMapping {
48
49         private static Logger log = Logger.getLogger(PrincipalNameIdentifier.class.getName());
50
51         public PrincipalNameIdentifier(Element config) throws NameIdentifierMappingException {
52
53                 super(config);
54         }
55
56         public AuthNPrincipal getPrincipal(SAMLNameIdentifier nameId, ServiceProvider sProv, IdentityProvider idProv)
57                         throws NameIdentifierMappingException, InvalidNameIdentifierException {
58
59                 verifyQualifier(nameId, idProv);
60                 return new AuthNPrincipal(nameId.getName());
61         }
62
63         public SAMLNameIdentifier getNameIdentifierName(AuthNPrincipal principal, ServiceProvider sProv,
64                         IdentityProvider idProv) throws NameIdentifierMappingException {
65
66                 if (principal == null) {
67                         log.error("A principal must be supplied for Name Identifier creation.");
68                         throw new IllegalArgumentException("A principal must be supplied for Name Identifier creation.");
69                 }
70
71                 try {
72                         return new SAMLNameIdentifier(principal.getName(), idProv.getProviderId(), getNameIdentifierFormat()
73                                         .toString());
74                 } catch (SAMLException e) {
75                         throw new NameIdentifierMappingException("Unable to generate Name Identifier: " + e);
76                 }
77         }
78 }