Package org.forgerock.openam.saml2.plugins

Interface IDPFinder

All Superinterfaces:

SAMLPlugin

All Known Subinterfaces:

SAML2IDPFinder

@EvolvingAll
public interface IDPFinder
extends SAMLPlugin

This interface IDPFinder is used to find a list of preferred Identity Authenticating providers to service the authentication request.

Field Summary

Fields inherited from interface org.forgerock.openam.saml2.plugins.SAMLPlugin

HOSTED_ENTITY_ID, REALM

Method Summary

Modifier and Type	Method	Description
List	getPreferredIDP(AuthnRequest authnRequest, String hostProviderID, String realm, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Returns a list of preferred IDP providerID's.

Method Detail

getPreferredIDP

List getPreferredIDP(AuthnRequest authnRequest,
                     String hostProviderID,
                     String realm,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws SAML2Exception

Returns a list of preferred IDP providerID's.

Parameters:

authnRequest - original authnrequest

hostProviderID - hosted providerID

realm - Realm

request - HttpServletRequest

response - HttpServletResponse

Returns:

a list of IDP providerID's or null if not found

Throws:

SAML2Exception - if error occurs