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