IDPAttributeMapper.java revision a688bcbb4bcff5398fdd29b86f83450257dc0df4
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007 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: IDPAttributeMapper.java,v 1.4 2008/06/25 05:48:07 qcheng Exp $
*
*/
/**
* This interface <code>IDPAttributeMapper</code> is used to map the
* authenticated user configured attributes to SAML <code>Attribute</code>s
* so that the SAML framework may insert these attribute information as SAML
* <code>AttributeStatement</code>s in SAML <code>Assertion</code>.
* The implementation of this interface can read the configured
* attributes or the attributes that are available through the Single
* Sign On Token and returns the SAML <code>Attribute</code>s.
* @see com.sun.identity.wsfederation.plugins.SPAttributeMapper
*
* @supported.all.api
*/
public interface IDPAttributeMapper {
/**
* Returns list of SAML <code>Attribute</code> objects for an
* authenticated user local attributes.
* @param session single sign on session of an authenticated user.
* @param hostEntityID <code>EntityID</code> of the hosted provider.
* @param remoteEntityID <code>EntityID</code> of the remote provider.
* @param realm realm name.
* @return list of <code>Attributes</code>s of an authenticated user.
* @exception WSFederationException if any failure.
*/
) throws WSFederationException;
}