Package net.shibboleth.idp.plugin.oidc.op.profile.impl

Class InitializeOutboundAuthenticationResponseMessageContext

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractInitializeOutboundResponseMessageContext

net.shibboleth.idp.plugin.oidc.op.profile.impl.InitializeOutboundAuthenticationResponseMessageContext

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class InitializeOutboundAuthenticationResponseMessageContext
extends AbstractInitializeOutboundResponseMessageContext

Action that adds an outbound MessageContext and related OIDC contexts to the ProfileRequestContext based on the identity of a relying party accessed via a lookup strategy, by default an immediate child of the profile request context. This action also initializes the SAMLMetadataContext and populates it with service and UIInfo -related data.

Event:

EventIds.PROCEED_EVENT_ID, IdPEventIds.INVALID_RELYING_PARTY_CTX, EventIds.INVALID_MSG_CTX

Field Summary

Fields

Modifier and Type	Field	Description
private String	defaultLanguage	The default language when it has not been defined in the metadata.
private final org.slf4j.Logger	log	Class logger.
private OIDCMetadataContext	oidcMetadataCtx	The OIDC metadata context used as a source for the SAML metadata context.
private Function<ProfileRequestContext,OIDCMetadataContext>	oidcMetadataCtxLookupStrategy	Strategy function to lookup the OIDCMetadataContext.
private RelyingPartyContext	relyingPartyCtx	The relying party context used for storing the SAML metadata context.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyCtxLookupStrategy	Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
private Function<ProfileRequestContext,SAMLMetadataContext>	samlMetadataCtxLookupStrategy	Strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext.
private Function<ProfileRequestContext,com.nimbusds.oauth2.sdk.id.ClientID>	unregisteredClientIdLookupStrategy	Strategy used to fetch the unregistered client ID value associated with a given ProfileRequestContext.

Constructor Summary

Constructors

Constructor	Description
InitializeOutboundAuthenticationResponseMessageContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
Function<ProfileRequestContext,OIDCMetadataContext>	getOIDCMetadataContextLookupStrategy()	Get the mechanism to lookup the OIDCMetadataContext from the ProfileRequestContext.
Function<ProfileRequestContext,RelyingPartyContext>	getRelyingPartyContextLookupStrategy()	Get the mechanism to lookup the RelyingPartyContext from the ProfileRequestContext.
Function<ProfileRequestContext,SAMLMetadataContext>	getSAMLMetadataContextLookupStrategy()	Get the mechanism to lookup the SAMLMetadataContext from the ProfileRequestContext.
protected void	populateEntityDescriptor(EntityDescriptor entityDescriptor, SPSSODescriptor spDescriptor, com.nimbusds.openid.connect.sdk.rp.OIDCClientInformation clientInformation)	Populates the corresponding elements at the given descriptors from the data from the given client information.
void	setDefaultLanguage(String language)	Set the default language when it has not been defined in the metadata.
void	setOIDCMetadataContextLookupStrategy(Function<ProfileRequestContext,OIDCMetadataContext> strgy)	Set the mechanism to lookup the OIDCMetadataContext from the ProfileRequestContext.
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
void	setSAMLMetadataContextLookupStrategy(Function<ProfileRequestContext,SAMLMetadataContext> strategy)	Set the strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext.
void	setUnregisteredClientIdLookupStrategy(Function<ProfileRequestContext,com.nimbusds.oauth2.sdk.id.ClientID> strategy)	Set the strategy used to fetch the unregistered client ID value associated with a given ProfileRequestContext.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractInitializeOutboundResponseMessageContext

setContextType

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

oidcMetadataCtxLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCMetadataContext> oidcMetadataCtxLookupStrategy

Strategy function to lookup the OIDCMetadataContext.

relyingPartyCtxLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyCtxLookupStrategy

Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

samlMetadataCtxLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SAMLMetadataContext> samlMetadataCtxLookupStrategy

Strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext.

unregisteredClientIdLookupStrategy

@Nonnull
private Function<ProfileRequestContext,com.nimbusds.oauth2.sdk.id.ClientID> unregisteredClientIdLookupStrategy

Strategy used to fetch the unregistered client ID value associated with a given ProfileRequestContext.

oidcMetadataCtx

@Nullable
private OIDCMetadataContext oidcMetadataCtx

The OIDC metadata context used as a source for the SAML metadata context.

relyingPartyCtx

@Nullable
private RelyingPartyContext relyingPartyCtx

The relying party context used for storing the SAML metadata context.

defaultLanguage

@Nonnull
private String defaultLanguage

The default language when it has not been defined in the metadata.

Constructor Details

InitializeOutboundAuthenticationResponseMessageContext

public InitializeOutboundAuthenticationResponseMessageContext()

Constructor.

Method Details

getOIDCMetadataContextLookupStrategy

@Nonnull
public Function<ProfileRequestContext,OIDCMetadataContext> getOIDCMetadataContextLookupStrategy()

Get the mechanism to lookup the OIDCMetadataContext from the ProfileRequestContext.

Returns:

The mechanism to lookup the OIDCMetadataContext from the ProfileRequestContext.

setOIDCMetadataContextLookupStrategy

public void setOIDCMetadataContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCMetadataContext> strgy)

Set the mechanism to lookup the OIDCMetadataContext from the ProfileRequestContext.

Parameters:

strgy - What to set.

getRelyingPartyContextLookupStrategy

@Nonnull
public Function<ProfileRequestContext,RelyingPartyContext> getRelyingPartyContextLookupStrategy()

Get the mechanism to lookup the RelyingPartyContext from the ProfileRequestContext.

Returns:

The mechanism to lookup the RelyingPartyContext from the ProfileRequestContext.

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,RelyingPartyContext> strategy)

Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Parameters:

strategy - strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext

getSAMLMetadataContextLookupStrategy

@Nonnull
public Function<ProfileRequestContext,SAMLMetadataContext> getSAMLMetadataContextLookupStrategy()

Get the mechanism to lookup the SAMLMetadataContext from the ProfileRequestContext.

Returns:

The mechanism to lookup the SAMLMetadataContext from the ProfileRequestContext.

setSAMLMetadataContextLookupStrategy

public void setSAMLMetadataContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,SAMLMetadataContext> strategy)

Set the strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext.

Parameters:

strategy - strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext

setUnregisteredClientIdLookupStrategy

public void setUnregisteredClientIdLookupStrategy(@Nonnull
 Function<ProfileRequestContext,com.nimbusds.oauth2.sdk.id.ClientID> strategy)

Set the strategy used to fetch the unregistered client ID value associated with a given ProfileRequestContext.

Parameters:

strategy - strategy used to fetch the unregistered client ID value associated with a given ProfileRequestContext.

setDefaultLanguage

public void setDefaultLanguage(@Nonnull
 String language)

Set the default language when it has not been defined in the metadata.

Parameters:

language - What to set.

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractInitializeOutboundResponseMessageContext

populateEntityDescriptor

protected void populateEntityDescriptor(EntityDescriptor entityDescriptor,
 SPSSODescriptor spDescriptor,
 @Nonnull
 com.nimbusds.openid.connect.sdk.rp.OIDCClientInformation clientInformation)

Populates the corresponding elements at the given descriptors from the data from the given client information.

Parameters:

entityDescriptor - The entity descriptor whose contact persons are populated.

spDescriptor - The SP descriptor whose UI info is populated.

clientInformation - The client information used as the source data.