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: IDPAttributeMapper.java,v 1.4 2008/06/25 05:48:07 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.wsfederation.plugins;
031
032import com.sun.identity.wsfederation.common.WSFederationException;
033
034
035/**
036 * This interface <code>IDPAttributeMapper</code> is used to map the 
037 * authenticated user configured attributes to SAML <code>Attribute</code>s
038 * so that the SAML framework may insert these attribute information as SAML 
039 * <code>AttributeStatement</code>s in SAML <code>Assertion</code>.
040 * The implementation of this interface can read the configured
041 * attributes or the attributes that are available through the Single
042 * Sign On Token and returns the SAML <code>Attribute</code>s.
043 * @see com.sun.identity.wsfederation.plugins.SPAttributeMapper
044 *
045 * @supported.all.api
046 */
047
048public interface IDPAttributeMapper {
049
050    /**
051     * Returns list of SAML <code>Attribute</code> objects for an 
052     * authenticated user local attributes.
053     * @param session single sign on session of an authenticated user.
054     * @param hostEntityID <code>EntityID</code> of the hosted provider.  
055     * @param remoteEntityID <code>EntityID</code> of the remote provider.  
056     * @param realm realm name.
057     * @return list of <code>Attributes</code>s of an authenticated user. 
058     * @exception WSFederationException if any failure.
059     */
060    public java.util.List getAttributes(
061        Object session,
062        java.lang.String hostEntityID,
063        java.lang.String remoteEntityID, 
064        java.lang.String realm
065    ) throws WSFederationException;
066
067
068}