FSRealmAttributeMapper.java revision f948ca04a28ccfeed9633bf4b0fb0d2c59c37478
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
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 * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
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 * $Id: FSRealmAttributeMapper.java,v 1.2 2008/06/25 05:46:55 qcheng Exp $
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * Portions Copyrighted 2014 ForgeRock AS
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The interface <code>FSRealmAttributeMapper</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 * @supported.all.api
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic interface FSRealmAttributeMapper {
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 realm The realm under which the entity resides.
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.