Import the eAuth subject plugin into HEAD.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / HSNameIdentifierMapping.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
48 package edu.internet2.middleware.shibboleth.hs;
49
50 import org.opensaml.SAMLNameIdentifier;
51
52 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
53 import edu.internet2.middleware.shibboleth.common.IdentityProvider;
54 import edu.internet2.middleware.shibboleth.common.NameIdentifierMapping;
55 import edu.internet2.middleware.shibboleth.common.NameIdentifierMappingException;
56 import edu.internet2.middleware.shibboleth.common.ServiceProvider;
57
58 /**
59  * Adds a mechanism to the {@link NameIdentifierMapping} interface for generating SAML Name Identifiers from 
60  * {@link AuthNPrincipal} objects.
61  * 
62  * @author Walter Hoehn
63  */
64 public interface HSNameIdentifierMapping extends NameIdentifierMapping {
65
66         /**
67          * @return the id of this mapping or <code>null</code> is it is not
68          *         configured with one
69          */
70         public String getId();
71
72         /**
73          * Maps a local principal to a SAML Name Identifier.
74          * 
75          * @param id
76          *            the id under which the effective {@link HSNameIdentifierMapping}
77          *            is registered
78          * @param principal
79          *            the principal to map
80          * @param sProv
81          *            the provider initiating the request
82          * @param idProv
83          *            the provider handling the request
84          * @return the SAML name identifier
85
86          * @throws NameIdentifierMappingException If the {@link NameMapper}
87          *         encounters an internal error
88          */
89         public SAMLNameIdentifier getNameIdentifierName(
90                 AuthNPrincipal principal,
91                 ServiceProvider sProv,
92                 IdentityProvider idProv)
93                 throws NameIdentifierMappingException;
94
95 }