001/*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: SPAccountMapper.java,v 1.5 2008/08/19 19:11:16 veiming Exp $
026 *
027 * Portions Copyrighted 2015 ForgeRock AS.
028 */
029
030package com.sun.identity.wsfederation.plugins;
031
032import com.sun.identity.wsfederation.common.WSFederationException;
033import com.sun.identity.wsfederation.profile.RequestSecurityTokenResponse;
034
035/**
036 * The class <code>PartnerAccountMapper</code> is an interface
037 * that is implemented to map partner account to user account
038 * in OpenAM.
039 * <p>
040 * Different partner would need to have a different implementation
041 * of the interface. The mappings between the partner source ID and 
042 * the implementation class are configured at the <code>Partner URLs</code> 
043 * field in SAML service.
044 *
045 * @supported.all.api
046 */
047
048public interface SPAccountMapper {
049    /**
050     * Returns user's distinguished name or the universal ID for the
051     * RSTR. This method will be invoked by the WS-Federation framework 
052     * while processing the <code>RequestSecurityTokenResponse</code> and 
053     * retrieves the identity information. 
054     *
055     * @param rstr the incoming <code>RequestSecurityTokenResponse</code>
056     * @param hostEntityID <code>EntityID</code> of the hosted provider.
057     * @param targetURL final target URL.
058     * @return user's disntinguished name or the universal ID.
059     * @exception WSFederationException if any failure.
060     */
061    public String getIdentity(RequestSecurityTokenResponse rstr,
062        String hostEntityID, String targetURL) throws WSFederationException;
063}