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

Class SelectMetadataLookupExtensionFlow

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.metadata.impl.SelectMetadataLookupExtensionFlow

All Implemented Interfaces:

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

public class SelectMetadataLookupExtensionFlow
extends AbstractProfileAction

A profile action that selects metadata lookup extension flows to invoke.

The flows available to be executed are held by the availableFlows. Available flows are executed in the order that they are configured if their activation condition evaluates to true.

This action returns the flow ID to be executed or EventIds.PROCEED_EVENT_ID if there are no flows available to be executed.

Event:

EventIds.PROCEED_EVENT_ID, Selected flow ID to execute

Field Summary

Fields

Modifier and Type	Field	Description
private Collection<MetadataLookupExtensionFlowDescriptor>	availableFlows	The available metadata lookup extension flows.
private Function<MessageContext,com.nimbusds.oauth2.sdk.id.ClientID>	clientIDLookupStrategy	The strategy used to obtain the client id value to be stored in the context.
private final org.slf4j.Logger	log	Class logger.
private MetadataLookupExtensionContext	metadataLookupExtensionContext	The context to operate on.
private Function<ProfileRequestContext,MetadataLookupExtensionContext>	metadataLookupExtensionContextCreationStrategy	The creation strategy for the metadata lookup extension context.
private Function<ProfileRequestContext,String>	profileIDLookupStrategy	The strategy used to obtain the profile id value to be stored in the context.

Constructor Summary

Constructors

Constructor	Description
SelectMetadataLookupExtensionFlow()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setAvailableFlows(Collection<MetadataLookupExtensionFlowDescriptor> flows)	Set the available metadata lookup extension flows.
void	setClientIDLookupStrategy(Function<MessageContext,com.nimbusds.oauth2.sdk.id.ClientID> strategy)	Set the strategy used to locate the client id of the request.
void	setMetadataLookupExtensionContextCreationStrategy(Function<ProfileRequestContext,MetadataLookupExtensionContext> strategy)	Set the creation strategy for the metadata lookup extension context.
void	setProfileIDLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the strategy used to locate the profile id to be used.

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.

metadataLookupExtensionContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,MetadataLookupExtensionContext> metadataLookupExtensionContextCreationStrategy

The creation strategy for the metadata lookup extension context.

availableFlows

@Nullable
private Collection<MetadataLookupExtensionFlowDescriptor> availableFlows

The available metadata lookup extension flows.

clientIDLookupStrategy

@Nonnull
private Function<MessageContext,com.nimbusds.oauth2.sdk.id.ClientID> clientIDLookupStrategy

The strategy used to obtain the client id value to be stored in the context.

profileIDLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,String> profileIDLookupStrategy

The strategy used to obtain the profile id value to be stored in the context.

metadataLookupExtensionContext

@NonnullBeforeExec
private MetadataLookupExtensionContext metadataLookupExtensionContext

The context to operate on.

Constructor Details

SelectMetadataLookupExtensionFlow

public SelectMetadataLookupExtensionFlow()

Constructor.

Method Details

setMetadataLookupExtensionContextCreationStrategy

public void setMetadataLookupExtensionContextCreationStrategy(@Nonnull
 Function<ProfileRequestContext,MetadataLookupExtensionContext> strategy)

Set the creation strategy for the metadata lookup extension context.

Parameters:

strategy - creation strategy

setAvailableFlows

public void setAvailableFlows(@Nullable
 Collection<MetadataLookupExtensionFlowDescriptor> flows)

Set the available metadata lookup extension flows.

Parameters:

flows - available metadata lookup flows

setClientIDLookupStrategy

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

Set the strategy used to locate the client id of the request.

Parameters:

strategy - lookup strategy

setProfileIDLookupStrategy

public void setProfileIDLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the strategy used to locate the profile id to be used.

Parameters:

strategy - lookup strategy

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