Package net.shibboleth.oidc.profile.messaging.handler.impl

Class AbstractLogoutRequestParameterValueMessageHandler<T>

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

net.shibboleth.oidc.profile.messaging.handler.impl.AbstractLogoutRequestParameterValueMessageHandler<T>

Type Parameters:

T - the logout request parameter value type TODO: move to commons

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

Direct Known Subclasses:

AddClientIDHandler, AddIDTokenHintHandler, AddLogoutHintHandler, AddLogoutUILocalesHandler, AddPostLogoutRedirectURIHandler

public abstract class AbstractLogoutRequestParameterValueMessageHandler<T>
extends AbstractMessageHandler

Base class for message handlers that process and apply values of OpenID Connect logout requests.

This abstract class provides common functionality for locating:

• the OIDCLogoutRequest associated with the current MessageContext,
• the OIDCProviderMetadata describing the peer OpenID Provider,
• and the parameter value to be extracted and validated against the expected Java type.

Field Summary

Fields

Modifier and Type	Field	Description
private OIDCLogoutRequest	logoutRequest	The stashed OIDCLogoutRequest.
private Function<MessageContext,OIDCLogoutRequest>	logoutRequestLookupStrategy	Strategy used to locate the OIDCLogoutRequest.
private Function<MessageContext,T>	parameterValueLookupStrategy	Lookup strategy for parameter value.
protected static final ParentProfileRequestContextLookup<MessageContext>	PRC_LOOKUP	Lookup function for parent ProfileRequestContext.
private com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata	providerMetadata	The stashed OpenID Provider metadata .
private Function<MessageContext,OIDCProviderMetadataContext>	providerMetadataLookupStrategy	Lookup strategy to locate the OpenID Provider metadata to use.
private final Class<T>	type	The logout request parameter value type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLogoutRequestParameterValueMessageHandler(Class<T> valueType)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected boolean	doPreInvoke(MessageContext messageContext)
protected OIDCLogoutRequest	getLogoutRequest()	Get the logout request.
protected T	getParameterValue(MessageContext context)	Retrieves the parameter value or configuration options from the configured lookup strategy, verifying at runtime that the result matches the type expected by the subclass.
protected com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata	getProviderMetadata()	Returns the OpenID Provider metadata.
void	setLogoutRequestLookupStrategy(Function<MessageContext,OIDCLogoutRequest> strategy)	Set the strategy used to locate the OIDCLogoutRequest to use.
void	setParameterValueLookupStrategy(Function<MessageContext,T> strategy)	Set the parameter value lookup strategy used to find the value to set onto the logout request.
void	setProviderMetadataLookupStrategy(Function<MessageContext,OIDCProviderMetadataContext> strategy)	Set the lookup strategy to locate the OpenID providers metadata.

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doInvoke, doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

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

PRC_LOOKUP

@Nonnull
protected static final ParentProfileRequestContextLookup<MessageContext> PRC_LOOKUP

Lookup function for parent ProfileRequestContext.

logoutRequestLookupStrategy

@NonnullAfterInit
private Function<MessageContext,OIDCLogoutRequest> logoutRequestLookupStrategy

Strategy used to locate the OIDCLogoutRequest.

providerMetadataLookupStrategy

@NonnullAfterInit
private Function<MessageContext,OIDCProviderMetadataContext> providerMetadataLookupStrategy

Lookup strategy to locate the OpenID Provider metadata to use.

parameterValueLookupStrategy

@Nullable
private Function<MessageContext,T> parameterValueLookupStrategy

Lookup strategy for parameter value.

type

@Nonnull
private final Class<T> type

The logout request parameter value type.

logoutRequest

@NonnullBeforeExec
private OIDCLogoutRequest logoutRequest

The stashed OIDCLogoutRequest.

providerMetadata

@NonnullBeforeExec
private com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata

The stashed OpenID Provider metadata .

Constructor Details

AbstractLogoutRequestParameterValueMessageHandler

protected AbstractLogoutRequestParameterValueMessageHandler(@Nonnull
 Class<T> valueType)

Constructor.

Parameters:

valueType - type of value returned by handler

Method Details

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

getLogoutRequest

@NonnullBeforeExec
protected OIDCLogoutRequest getLogoutRequest()

Get the logout request.

Returns:

the logout request

setProviderMetadataLookupStrategy

public void setProviderMetadataLookupStrategy(@Nonnull
 Function<MessageContext,OIDCProviderMetadataContext> strategy)

Set the lookup strategy to locate the OpenID providers metadata.

Parameters:

strategy - the strategy.

getProviderMetadata

@NonnullBeforeExec
protected com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata getProviderMetadata()

Returns the OpenID Provider metadata. Should never be null after doPreExecute has been called.

Returns:

The provider metadata context.

setParameterValueLookupStrategy

public void setParameterValueLookupStrategy(@Nonnull
 Function<MessageContext,T> strategy)

Set the parameter value lookup strategy used to find the value to set onto the logout request.

Parameters:

strategy - The parameter value lookup strategy to set.

getParameterValue

@Nullable
protected T getParameterValue(@Nonnull
 MessageContext context)
                       throws MessageHandlerException

Retrieves the parameter value or configuration options from the configured lookup strategy, verifying at runtime that the result matches the type expected by the subclass.

Parameters:

context - the message context to pass to the lookup function

Returns:

the parameter value

Throws:

MessageHandlerException - if the value is not the expected type

setLogoutRequestLookupStrategy

public void setLogoutRequestLookupStrategy(@Nonnull
 Function<MessageContext,OIDCLogoutRequest> strategy)

Set the strategy used to locate the OIDCLogoutRequest to use.

Parameters:

strategy - lookup strategy

doPreInvoke

protected boolean doPreInvoke(@Nonnull
 MessageContext messageContext)
                       throws MessageHandlerException

Overrides:

doPreInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException