FSRealmIDPProxy (OpenAM Project 16.0.0-SNAPSHOT API)

All Known Implementing Classes:

FSRealmIDPProxyImpl
```
@Deprecated
public interface FSRealmIDPProxy
```
Deprecated.
since 12.0.0

This interface FSRealmIDPProxy is used to find a preferred Identity Authenticating provider to proxy the authentication request.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getPreferredIDP(FSAuthnRequest authnRequest, String realm, String hostProviderID, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)`	Deprecated. Returns the preferred IDP.

- Method Detail
  - getPreferredIDP
```
String getPreferredIDP(FSAuthnRequest authnRequest,
                       String realm,
                       String hostProviderID,
                       jakarta.servlet.http.HttpServletRequest request,
                       jakarta.servlet.http.HttpServletResponse response)
                throws FSRedirectException
```
    Deprecated.
    
    Returns the preferred IDP.
    
    Parameters:
    
    authnRequest - original authnrequest
    
    realm - The realm under which the entity resides.
    
    hostProviderID - ProxyIDP providerID.
    
    request - HttpServletRequest
    
    response - HttpServletResponse
    
    Returns:
    
    providerID of the authenticating provider to be proxied. null to disable the proxying and continue for the local authenticating provider.
    
    Throws:
    
    FSRedirectException - if redirect was done