a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: FSAttributeMapper.java,v 1.3 2008/06/25 05:46:52 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.federation.services;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.List;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Map;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The interface <code>FSAttributeMapper</code> is a plugin for
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * mapping the <code>Attribute</code>s during the single sign-on at the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>ServiceProvider</code> of the Liberty protocols. The service
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * provider while it is validating the <code>Assertion</code> uses this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * plugin to map the <code>Attribute</code>s that are passed from the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Identity provider to local attributes so that the assertion consumer
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * service will populate these attributes to the application via the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * single sign-on token.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </p>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @deprecated This SPI is deprecated.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see com.sun.identity.federation.services.FSRealmAttributeMapper
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic interface FSAttributeMapper {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the map of local attributes for the given list of attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * statements.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param attributeStatements list of <code>AttributeStatement</code>s.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param hostEntityId Hosted provider entity id.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param remoteEntityId Remote provider entity id.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param token Single sign-on session token.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return map of attribute value pairs. This map will have the key
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * as the attribute name and the value is the attribute value.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Map getAttributes(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster List attributeStatements,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String hostEntityId,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String remoteEntityId,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Object token);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}