Package com.sun.identity.saml2.plugins

Interface IDPAuthnContextMapper

All Superinterfaces:

SAMLPlugin

@SupportedAll
public interface IDPAuthnContextMapper
extends SAMLPlugin

The interface IDPAuthnContextMapper creates an IDPAuthnContextInfo based on the RequestAuthnContext from the AuthnRequest sent by a Service Provider and the AuthnContext configuration at the IDP entity config. The implementation of this class will be used by the IDP to find out the authentication mechaism and set the AuthnContext in the Assertion.

Field Summary

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

HOSTED_ENTITY_ID, REALM

Method Summary

Modifier and Type	Method	Description
AuthnContext	getAuthnContextFromAuthLevel(String authLevel, String realm, String idpEntityID)	Returns AuthnContext that matches the authenticated level.
IDPAuthnContextInfo	getIDPAuthnContextInfo(AuthnRequest authnRequest, String idpEntityID, String realm)	Deprecated. use getIDPAuthnContextInfo(AuthnRequest, String, String, String) instead
default IDPAuthnContextInfo	getIDPAuthnContextInfo(AuthnRequest authnRequest, String idpEntityID, String realm, String spEntityID)	Returns an IDPAuthnContextInfo object.
boolean	isAuthnContextMatching(List requestedACClassRefs, String acClassRef, String comparison, String realm, String idpEntityID)	Returns true if the specified AuthnContextClassRef matches a list of requested AuthnContextClassRef.

Method Detail

getIDPAuthnContextInfo

IDPAuthnContextInfo getIDPAuthnContextInfo(AuthnRequest authnRequest,
                                           String idpEntityID,
                                           String realm)
                                    throws SAML2Exception

Deprecated.

use getIDPAuthnContextInfo(AuthnRequest, String, String, String) instead

Returns an IDPAuthnContextInfo object.

Parameters:

authnRequest - the AuthnRequest from the Service Provider

idpEntityID - the Entity ID of the Identity Provider

realm - the realm to which the Identity Provider belongs

Returns:

an IDPAuthnContextInfo object

Throws:

SAML2Exception - if an error occurs.

getIDPAuthnContextInfo

default IDPAuthnContextInfo getIDPAuthnContextInfo(AuthnRequest authnRequest,
                                                   String idpEntityID,
                                                   String realm,
                                                   String spEntityID)
                                            throws SAML2Exception

Returns an IDPAuthnContextInfo object.

Parameters:

authnRequest - the AuthnRequest from the Service Provider

idpEntityID - the Entity ID of the Identity Provider

realm - the realm to which the Identity Provider belongs

spEntityID - the Entity ID of the Service Provider

Returns:

an IDPAuthnContextInfo object

Throws:

SAML2Exception - if an error occurs.

isAuthnContextMatching

boolean isAuthnContextMatching(List requestedACClassRefs,
                               String acClassRef,
                               String comparison,
                               String realm,
                               String idpEntityID)

Returns true if the specified AuthnContextClassRef matches a list of requested AuthnContextClassRef.

Parameters:

requestedACClassRefs - a list of requested AuthnContextClassRef's

acClassRef - AuthnContextClassRef

comparison - the type of comparison

realm - the realm to which the Identity Provider belongs

idpEntityID - the Entity ID of the Identity Provider

Returns:

true if the specified AuthnContextClassRef matches a list of requested AuthnContextClassRef

getAuthnContextFromAuthLevel

AuthnContext getAuthnContextFromAuthLevel(String authLevel,
                                          String realm,
                                          String idpEntityID)
                                   throws SAML2Exception

Returns AuthnContext that matches the authenticated level.

Parameters:

authLevel - user authenticated level

realm - the realm to which the Identity Provider belongs

idpEntityID - the Entity ID of the Identity Provider

Returns:

AuthnContext object that matches authenticated level.

Throws:

SAML2Exception - if an error occurs.