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: IDPAuthenticationMethodMapper.java,v 1.3 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 * The interface <code>IDPAuthenticationMethodMapper</code> creates an
037 * <code>IDPAuthenticationTypeInfo<code> based on the RequestAuthnContext from
038 * the AuthnRequest sent by a Service Provider and the AuthnContext
039 * configuration at the IDP entity config.
040 * The implementation of this class will be used by the IDP to find out
041 * the authentication mechaism and set the AuthnContext in the Assertion.
042 * 
043 * 
044 * @supported.all.api 
045 */ 
046
047public interface IDPAuthenticationMethodMapper {
048
049   /**
050     * 
051     * Returns an <code>IDPAuthenticationTypeInfo</code> object.
052     * 
053     * @param authenticationType the <code>AuthenticationType</code> from the 
054     * Service Provider
055     * @param idpEntityID the Entity ID of the Identity Provider
056     * @param realm the realm to which the Identity Provider belongs
057     * @return an <code>IDPAuthenticationTypeInfo</code> object
058     * @throws WSFederationException if an error occurs.
059     */
060    public IDPAuthenticationTypeInfo getIDPAuthnContextInfo(
061        String authenticationType,
062        String idpEntityID,
063        String realm) throws WSFederationException;
064
065}