Package net.shibboleth.idp.authn.proxy.impl

Class DiscoveryProfileRequestFunction

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.idp.authn.proxy.impl.DiscoveryProfileRequestFunction

All Implemented Interfaces:

BiFunction<RequestContext,ProfileRequestContext,String>, Component, DestructableComponent, InitializableComponent

@ThreadSafe
public class DiscoveryProfileRequestFunction
extends AbstractInitializableComponent
implements BiFunction<RequestContext,ProfileRequestContext,String>

A Function that produces a discovery request URL using the protocol defined in https://wiki.oasis-open.org/security/IdpDiscoSvcProtonProfile

Since there is no upstream "relying party" yet, the identity of the system is derived from the currently in-effect entityID that will be used to respond to the downstream relying party.

Field Summary

Fields

Modifier and Type	Field	Description
private BiFunction<RequestContext,ProfileRequestContext,String>	delegatedRequestFunction	Overrides this function via an injected bean.
private Function<ProfileRequestContext,String>	discoveryURLLookupStrategy	Lookup strategy for determining the "base" discovery URL.
private Escaper	escaper	URL query parameter escaper.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Lookup strategy for locating RelyingPartyContext.

Constructor Summary

Constructors

Constructor	Description
DiscoveryProfileRequestFunction()	Constructor.

Method Summary

Modifier and Type	Method	Description
String	apply(RequestContext springRequestContext, ProfileRequestContext profileRequestContext)
protected void	doInitialize()
void	setDelegatedRequestFunction(BiFunction<RequestContext,ProfileRequestContext,String> delegate)	Set a function to call in place of this built-in class to generate the request.
void	setDiscoveryURLLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the lookup strategy for the "base" discovery service URL to use.
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the lookup strategy for the RelyingPartyContext.

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 java.util.function.BiFunction

andThen

Field Details

escaper

@Nonnull
private Escaper escaper

URL query parameter escaper.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Lookup strategy for locating RelyingPartyContext.

discoveryURLLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,String> discoveryURLLookupStrategy

Lookup strategy for determining the "base" discovery URL.

delegatedRequestFunction

@Nullable
private BiFunction<RequestContext,ProfileRequestContext,String> delegatedRequestFunction

Overrides this function via an injected bean.

Constructor Details

DiscoveryProfileRequestFunction

public DiscoveryProfileRequestFunction()

Constructor.

Method Details

setRelyingPartyContextLookupStrategy

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

Set the lookup strategy for the RelyingPartyContext.

Parameters:

strategy - lookup strategy

setDiscoveryURLLookupStrategy

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

Set the lookup strategy for the "base" discovery service URL to use.

Parameters:

strategy - lookup strategy

setDelegatedRequestFunction

public void setDelegatedRequestFunction(@Nullable
 BiFunction<RequestContext,ProfileRequestContext,String> delegate)

Set a function to call in place of this built-in class to generate the request.

This is a mechanism to account for how this function gets used in the discovery flow.

Parameters:

delegate - the function to delegate to

Since:

5.0.0

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

apply

@Nullable
public String apply(@Nullable
 RequestContext springRequestContext,
 @Nullable
 ProfileRequestContext profileRequestContext)

Specified by:

apply in interface BiFunction<RequestContext,ProfileRequestContext,String>