NameIdentifierMapper.java revision 0c9f0c5f2c3eb18b0b4736e234e0091b9f90db21
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: NameIdentifierMapper.java,v 1.4 2008/08/19 19:11:14 veiming Exp $
*
*/
/**
* Portions Copyrighted 2013 ForgeRock AS
*/
/**
* The class <code>NameIdentifierMapper</code> is an interface
* that is implemented to map user account to name identifier in
* assertion subject in OpenAM.
*
* @supported.all.api
*/
public interface NameIdentifierMapper {
/**
* Returns name identifier for assertion subject based on user account in
* the data store.
*
* @param session the session of the user performing the SSO operation.
* @param sourceID source ID for the site from which the assertion
* originated.
* @param destID destination ID for the site for which the assertion will be
* created.
* @param nameIDFormat The NameID-Format.
* @return a <code>NameIdentifier</code> for assertion subject.
* @exception SAMLException if an error occurs
*/
}