Package net.shibboleth.sp.profile.impl

Class SelectRelyingPartyConfiguration

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.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.AbstractAgentAction

net.shibboleth.sp.profile.AbstractApplicationAction

net.shibboleth.sp.profile.impl.SelectRelyingPartyConfiguration

All Implemented Interfaces:

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

public final class SelectRelyingPartyConfiguration
extends AbstractApplicationAction

This action attempts to resolve a RelyingPartyConfiguration and adds it to a RelyingPartyContext, using the requesting Application as the source of configurations rather than the generic resolver used by the IdP.

A flag exists for the use of the SAML ECP profile such that the absence of a relying party ID is handled specially as a "verified" request so that the default configuration is resolved instead of the unverified configuration. SAML ECP is the only such scenario.

Event:

EventIds.PROCEED_EVENT_ID, IdPEventIds.INVALID_RELYING_PARTY_CTX, IdPEventIds.INVALID_RELYING_PARTY_CONFIG

Postcondition:

If a RelyingPartyContext is located, it will be populated with a non-null result of applying the applicaton's RelyingPartyConfigurationResolver to the ProfileRequestContext.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
private RelyingPartyContext	relyingPartyCtx	The RelyingPartyContext to manipulate.
private boolean	treatAnonymousAsVerified	Flag alllowing anonymous context to be resolved as verified.

Constructor Summary

Constructors

Constructor	Description
SelectRelyingPartyConfiguration()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	doExecute(ProfileRequestContext profileRequestContext)
boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private RelyingPartyContext	getRelyingPartyCtx()	Null safe getter.
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
void	setTreatAnonymousAsVerified(boolean flag)	Sets whether the lack of a relying party ID in the context is handled specially as a "verified" configuration resolution rather than unverified as would typically occur.

Methods inherited from class net.shibboleth.sp.profile.AbstractApplicationAction

ensureApplication, getApplication

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

ensureAgent, getAgent

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

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.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

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

treatAnonymousAsVerified

private boolean treatAnonymousAsVerified

Flag alllowing anonymous context to be resolved as verified.

relyingPartyCtx

@NonnullBeforeExec
private RelyingPartyContext relyingPartyCtx

The RelyingPartyContext to manipulate.

Constructor Details

SelectRelyingPartyConfiguration

public SelectRelyingPartyConfiguration()

Constructor.

Method Details

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

setTreatAnonymousAsVerified

public void setTreatAnonymousAsVerified(boolean flag)

Sets whether the lack of a relying party ID in the context is handled specially as a "verified" configuration resolution rather than unverified as would typically occur.

Defaults to false.

Parameters:

flag - flag to set

getRelyingPartyCtx

@Nonnull
private RelyingPartyContext getRelyingPartyCtx()

Null safe getter.

Returns:

Returns the relyingPartyCtx.

doPreExecute

public boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractApplicationAction

doExecute

public void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction