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

Class InitializeRegistrationMetadataPolicyContext

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.InitializeRegistrationMetadataPolicyContext

All Implemented Interfaces:

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

public class InitializeRegistrationMetadataPolicyContext
extends AbstractProfileAction

Initializes the OIDCClientRegistrationMetadataPolicyContext and attaches it as a subcontext for the incoming MessageContext. The context contains the merged metadata policy, containing the policy items defined in the profile configuration and initial registration access token (if involved).

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private OIDCClientRegistrationMetadataPolicyContext	metadataPolicyContext	The metadata policy context to operate on.
private BiFunction<Map<String,MetadataPolicy>,Map<String,MetadataPolicy>,Pair<Map<String,MetadataPolicy>,Boolean>>	metadataPolicyMergingStrategy	The strategy used for merging profile and token based metadata policies.
private Predicate<Map<String,MetadataPolicy>>	metadataPolicyValidationStrategy	The strategy used for validating token and merged metadata policies.
private Function<ProfileRequestContext,Map<String,MetadataPolicy>>	profileMetadataPolicyLookupStrategy	The strategy used to locate the request metadata policy configured for the profile.
private Function<ProfileRequestContext,OIDCClientRegistrationMetadataPolicyContext>	registrationPolicyContextCreationStrategy	The strategy used to create or locate the metadata policy context.
private Function<ProfileRequestContext,Map<String,MetadataPolicy>>	tokenMetadataPolicyLookupStrategy	The strategy used to locate the request metadata policy encoded in the access token.

Constructor Summary

Constructors

Constructor	Description
InitializeRegistrationMetadataPolicyContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setMetadataPolicyMergingStrategy(BiFunction<Map<String,MetadataPolicy>,Map<String,MetadataPolicy>,Pair<Map<String,MetadataPolicy>,Boolean>> strategy)	Set the strategy used for merging profile and token based metadata policies.
void	setMetadataPolicyValidationStrategy(Predicate<Map<String,MetadataPolicy>> strategy)	Set the strategy used for validating token and merged metadata policies.
void	setProfileMetadataPolicyLookupStrategy(Function<ProfileRequestContext,Map<String,MetadataPolicy>> strategy)	Set the strategy used to locate the request metadata policy configured for the profile.
void	setRegistrationPolicyContextCreationStrategy(Function<ProfileRequestContext,OIDCClientRegistrationMetadataPolicyContext> strategy)	Set the strategy used to create or return the OIDCClientRegistrationMetadataPolicyContext.
void	setTokenMetadataPolicyLookupStrategy(Function<ProfileRequestContext,Map<String,MetadataPolicy>> strategy)	Set the strategy used to locate the request metadata policy encoded in the access token.

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, 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.

profileMetadataPolicyLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Map<String,MetadataPolicy>> profileMetadataPolicyLookupStrategy

The strategy used to locate the request metadata policy configured for the profile.

tokenMetadataPolicyLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Map<String,MetadataPolicy>> tokenMetadataPolicyLookupStrategy

The strategy used to locate the request metadata policy encoded in the access token.

registrationPolicyContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCClientRegistrationMetadataPolicyContext> registrationPolicyContextCreationStrategy

The strategy used to create or locate the metadata policy context.

metadataPolicyMergingStrategy

@Nonnull
private BiFunction<Map<String,MetadataPolicy>,Map<String,MetadataPolicy>,Pair<Map<String,MetadataPolicy>,Boolean>> metadataPolicyMergingStrategy

The strategy used for merging profile and token based metadata policies.

metadataPolicyValidationStrategy

@NonnullAfterInit
private Predicate<Map<String,MetadataPolicy>> metadataPolicyValidationStrategy

The strategy used for validating token and merged metadata policies.

metadataPolicyContext

private OIDCClientRegistrationMetadataPolicyContext metadataPolicyContext

The metadata policy context to operate on.

Constructor Details

InitializeRegistrationMetadataPolicyContext

public InitializeRegistrationMetadataPolicyContext()

Constructor.

Method Details

setProfileMetadataPolicyLookupStrategy

public void setProfileMetadataPolicyLookupStrategy(@Nonnull
 Function<ProfileRequestContext,Map<String,MetadataPolicy>> strategy)

Set the strategy used to locate the request metadata policy configured for the profile.

Parameters:

strategy - What to set.

setTokenMetadataPolicyLookupStrategy

public void setTokenMetadataPolicyLookupStrategy(@Nonnull
 Function<ProfileRequestContext,Map<String,MetadataPolicy>> strategy)

Set the strategy used to locate the request metadata policy encoded in the access token.

Parameters:

strategy - What to set.

setRegistrationPolicyContextCreationStrategy

public void setRegistrationPolicyContextCreationStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCClientRegistrationMetadataPolicyContext> strategy)

Set the strategy used to create or return the OIDCClientRegistrationMetadataPolicyContext.

Parameters:

strategy - What to set.

setMetadataPolicyMergingStrategy

public void setMetadataPolicyMergingStrategy(@Nonnull
 BiFunction<Map<String,MetadataPolicy>,Map<String,MetadataPolicy>,Pair<Map<String,MetadataPolicy>,Boolean>> strategy)

Set the strategy used for merging profile and token based metadata policies.

Parameters:

strategy - What to set.

setMetadataPolicyValidationStrategy

public void setMetadataPolicyValidationStrategy(@Nonnull
 Predicate<Map<String,MetadataPolicy>> strategy)

Set the strategy used for validating token and merged metadata policies.

Parameters:

strategy - What to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction