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

Class InitializeRelyingPartyContext

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

All Implemented Interfaces:

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

public class InitializeRelyingPartyContext
extends AbstractProfileAction

Action that adds a RelyingPartyContext to the current ProfileRequestContext tree via a creation function.

Event:

EventIds.INVALID_MSG_CTX, EventIds.INVALID_PROFILE_CTX, IdPEventIds.INVALID_RELYING_PARTY_CTX

Postcondition:

ProfileRequestContext.getSubcontext(RelyingPartyContext.class) != null with relying party id set.

Field Summary

Fields

Modifier and Type	Field	Description
private com.nimbusds.oauth2.sdk.id.ClientID	clientId	OIDC client id.
private Function<MessageContext,com.nimbusds.oauth2.sdk.id.ClientID>	clientIDLookupStrategy	Strategy used to obtain the client id value for authorize/token request.
private boolean	inbound	Use the inbound message tree?
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,OIDCMetadataContext>	oidcMetadataContextLookupStrategy	Strategy that will return OIDCMetadataContext.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextCreationStrategy	Strategy that will return or create a RelyingPartyContext.

Constructor Summary

Constructors

Constructor	Description
InitializeRelyingPartyContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setClientIDLookupStrategy(Function<MessageContext,com.nimbusds.oauth2.sdk.id.ClientID> strategy)	Set the strategy used to locate the client id of the request.
void	setInbound(boolean flag)	Sets which message tree to use in deriving the ClientID and OIDC metadata.
void	setOidcMetadataContextLookupStrategy(Function<ProfileRequestContext,OIDCMetadataContext> strategy)	Set the strategy used to return the OIDCMetadataContext.
void	setRelyingPartyContextCreationStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the strategy used to return or create the RelyingPartyContext .

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.

relyingPartyContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextCreationStrategy

Strategy that will return or create a RelyingPartyContext.

oidcMetadataContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCMetadataContext> oidcMetadataContextLookupStrategy

Strategy that will return OIDCMetadataContext.

clientIDLookupStrategy

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

Strategy used to obtain the client id value for authorize/token request.

clientId

@Nullable
private com.nimbusds.oauth2.sdk.id.ClientID clientId

OIDC client id.

inbound

private boolean inbound

Use the inbound message tree?

Constructor Details

InitializeRelyingPartyContext

public InitializeRelyingPartyContext()

Constructor.

Method Details

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

setRelyingPartyContextCreationStrategy

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

Set the strategy used to return or create the RelyingPartyContext .

Parameters:

strategy - creation strategy

setOidcMetadataContextLookupStrategy

public void setOidcMetadataContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCMetadataContext> strategy)

Set the strategy used to return the OIDCMetadataContext.

Parameters:

strategy - The lookup strategy.

setInbound

public void setInbound(boolean flag)

Sets which message tree to use in deriving the ClientID and OIDC metadata.

Defaults to true (the inbound tree).

Parameters:

flag - true iff the inbound tree should be used

Since:

3.1.0

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction