Unifed NameMapper and HSNameMapper interfaces for use by the new IdPResponder servlet.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / common / BaseNameIdentifierMapping.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.common;
27
28 import java.net.URI;
29 import java.net.URISyntaxException;
30
31 import org.apache.log4j.Logger;
32 import org.opensaml.SAMLNameIdentifier;
33 import org.w3c.dom.Element;
34
35 /**
36  * Base class for processing name identifier mapping configuration.
37  * 
38  * @author Walter Hoehn
39  */
40 public abstract class BaseNameIdentifierMapping implements NameIdentifierMapping {
41
42         private static Logger log = Logger.getLogger(BaseNameIdentifierMapping.class.getName());
43         private URI format;
44         private String id;
45
46         public BaseNameIdentifierMapping(Element config) throws NameIdentifierMappingException {
47
48                 if (!config.getLocalName().equals("NameMapping")) { throw new IllegalArgumentException(); }
49
50                 String rawFormat = ((Element) config).getAttribute("format");
51                 if (rawFormat == null || rawFormat.equals("")) {
52                         log.error("Name Mapping requires a \"format\" attribute.");
53                         throw new NameIdentifierMappingException("Invalid mapping information specified.");
54                 }
55
56                 try {
57                         format = new URI(rawFormat);
58                 } catch (URISyntaxException e) {
59                         log.error("Name Mapping attribute \"format\" is not a valid URI: " + e);
60                         throw new NameIdentifierMappingException("Invalid mapping information specified.");
61                 }
62
63                 String id = ((Element) config).getAttribute("id");
64                 if (id != null || !id.equals("")) {
65                         this.id = id;
66                 }
67
68         }
69
70         public URI getNameIdentifierFormat() {
71
72                 return format;
73         }
74
75         public String getId() {
76
77                 return id;
78         }
79
80         public void destroy() {
81
82         //nothing to do
83         }
84
85         protected void verifyQualifier(SAMLNameIdentifier nameId, IdentityProvider idProv)
86                         throws NameIdentifierMappingException {
87
88                 if (idProv.getProviderId() == null || !idProv.getProviderId().equals(nameId.getNameQualifier())) {
89                         log.error("The name qualifier (" + nameId.getNameQualifier()
90                                         + ") for the referenced subject is not valid for this identity provider.");
91                         throw new NameIdentifierMappingException("The name qualifier (" + nameId.getNameQualifier()
92                                         + ") for the referenced subject is not valid for this identity provider.");
93                 }
94         }
95 }