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: SAML2IDPFinder.java,v 1.3 2008/12/03 00:34:10 hengming Exp $ 026 * 027 */ 028 029package com.sun.identity.saml2.plugins; 030 031import java.util.List; 032import com.sun.identity.saml2.common.SAML2Exception; 033import com.sun.identity.saml2.protocol.AuthnRequest; 034import javax.servlet.http.HttpServletRequest; 035import javax.servlet.http.HttpServletResponse; 036 037/** 038 * This interface <code>SAML2IDPFinder</code> is used to find a list of 039 * preferred Identity Authenticating providers to service the authentication 040 * request. 041 * 042 * @supported.all.api 043 */ 044public interface SAML2IDPFinder { 045 046 /** 047 * Returns a list of preferred IDP providerID's. 048 * @param authnRequest original authnrequest 049 * @param hostProviderID hosted providerID. 050 * @param realm Realm 051 * @param request HttpServletRequest 052 * @param response HttpServletResponse 053 * @return a list of IDP providerID's or null if not found. 054 * @exception SAML2Exception if error occurs. 055 */ 056 public List getPreferredIDP ( 057 AuthnRequest authnRequest, 058 String hostProviderID, 059 String realm, 060 HttpServletRequest request, 061 HttpServletResponse response 062 ) throws SAML2Exception; 063}
Copyright © 2010-2017, ForgeRock All Rights Reserved.