/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: SAML2IDPFinder.java,v 1.3 2008/12/03 00:34:10 hengming Exp $
*
*/
/**
* This interface <code>SAML2IDPFinder</code> is used to find a list of
* preferred Identity Authenticating providers to service the authentication
* request.
*
* @supported.all.api
*/
public interface SAML2IDPFinder {
/**
* Returns a list of preferred IDP providerID's.
* @param authnRequest original authnrequest
* @param hostProviderID hosted providerID.
* @param realm Realm
* @param request HttpServletRequest
* @param response HttpServletResponse
* @return a list of IDP providerID's or null if not found.
* @exception SAML2Exception if error occurs.
*/
) throws SAML2Exception;
}