001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyrighted [year] [name of copyright owner]".
013 *
014 * Copyright 2015-2016 ForgeRock AS.
015 */
016
017package org.forgerock.openam.sts.rest.token.provider.oidc;
018
019import org.forgerock.json.JsonValue;
020import org.forgerock.openam.sts.TokenTypeId;
021
022import java.util.Set;
023
024/**
025 * An interface which allows soap-sts publishers to generate the amr claim for issued OpenIdConnect tokens on the basis
026 * of the validated input token. See the amr claim here: http://openid.net/specs/openid-connect-core-1_0.html#IDToken.
027 *
028 * @supported.all.api
029 */
030public interface OpenIdConnectTokenAuthMethodReferencesMapper {
031    /**
032     * Returns the Set of authentication methods references corresponding to the TokenType inputToken.
033     * @param inputTokenType The input token type passed as input to the token transformation operation
034     * @param inputToken The input token passed as input to the token transformation operation
035     * @return A set of authentication method references appropriate to the validation of the input token type.
036     */
037    Set<String> getAuthnMethodsReferences(TokenTypeId inputTokenType, JsonValue inputToken);
038}