Package org.forgerock.openam.saml2

Interface IDPRequestValidator

All Known Implementing Classes:

UtilProxyIDPRequestValidator

public interface IDPRequestValidator

Responsible for validating and providing a handful of parameters required for processing the IDP requests. Note: Currently all supporting classes have extensive static initialisation which is preventing this class from providing more immutability.

Method Summary

Modifier and Type	Method	Description
SAML2IdentityProviderAdapter	getIDPAdapter(String realm, String idpEntityID)	Loads the SAML2IdentityProviderAdapter IDP adapter which will be called as part of IDP processing.
String	getIDPEntity(String idpMetaAlias, String realm)	The entity identifier for the IDP.
String	getMetaAlias(jakarta.servlet.http.HttpServletRequest request)	The meta alias is used to locate the provider's entity identifier and the organization in which it is located.
String	getRealmByMetaAlias(String idpMetaAlias)	Gets the realm for the entity from the IDP Meta Alias.

Method Detail

getMetaAlias

String getMetaAlias(jakarta.servlet.http.HttpServletRequest request)
             throws ClientFaultException

The meta alias is used to locate the provider's entity identifier and the organization in which it is located.

Returns:

A non null string closely resembling the entities realm.

Throws:

ClientFaultException - If the meta alias was not provided in the request or could not be parsed out of the request URI.

getIDPEntity

String getIDPEntity(String idpMetaAlias,
                    String realm)
             throws ServerFaultException,
                    ClientFaultException

The entity identifier for the IDP.

Parameters:

idpMetaAlias - Non null meta alias.

Returns:

Non null String

Throws:

ServerFaultException - If unable to read the IDP Entity ID from the realm meta.

ClientFaultException - If the client requested an invalid binding for this IDP.

getIDPAdapter

SAML2IdentityProviderAdapter getIDPAdapter(String realm,
                                           String idpEntityID)

Loads the SAML2IdentityProviderAdapter IDP adapter which will be called as part of IDP processing.

Parameters:

realm - Possibly null realm.

idpEntityID - Non null idpEntityID.

Returns:

The loaded SAML2IdentityProviderAdapter if it could be loaded otherwise the default implementation DefaultIDPAdapter.

getRealmByMetaAlias

String getRealmByMetaAlias(String idpMetaAlias)

Gets the realm for the entity from the IDP Meta Alias.

Parameters:

idpMetaAlias - the IDP Meta Alias

Returns:

the realm that the idp belongs to