Package net.shibboleth.oidc.profile.oauth2.config.impl

Class AbstractOAuth2InterceptorAwareProfileConfiguration

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.profile.config.AbstractProfileConfiguration

net.shibboleth.profile.config.AbstractConditionalProfileConfiguration

net.shibboleth.idp.profile.config.AbstractInterceptorAwareProfileConfiguration

net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2InterceptorAwareProfileConfiguration

All Implemented Interfaces:

InterceptorAwareProfileConfiguration, OAuth2InterceptorAwareProfileConfiguration, OAuth2ProfileConfiguration, ConditionalProfileConfiguration, ProfileConfiguration, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

AbstractOAuth2ClientAuthenticableProfileConfiguration, DefaultOAuth2TokenAudienceConfiguration, DefaultOIDCLogoutConfiguration

public abstract class AbstractOAuth2InterceptorAwareProfileConfiguration
extends AbstractInterceptorAwareProfileConfiguration
implements OAuth2InterceptorAwareProfileConfiguration

Abstract profile configuration implementation for interceptor flow aware OAuth2 profile configurations.

Since:

3.2.0

Field Summary

Fields

Modifier and Type	Field	Description
private Function<MessageContext,Function<MessageContext,Exception>>	messageHandlerLookupStrategy	Lookup strategy for message handler.

Fields inherited from interface net.shibboleth.profile.config.ProfileConfiguration

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Constructor	Description
AbstractOAuth2InterceptorAwareProfileConfiguration(String profileId)	Constructor.

Method Summary

Modifier and Type	Method	Description
Function<MessageContext,Exception>	getMessageHandler(MessageContext messageContext)	Get a custom handler for a message produced or consumed by this profile.
void	setMessageHandler(Function<MessageContext,Exception> handler)	Set a handler for the message.
void	setMessageHandlerLookupStrategy(Function<MessageContext,Function<MessageContext,Exception>> strategy)	Set a lookup strategy for the handler for the message.

Methods inherited from class net.shibboleth.idp.profile.config.AbstractInterceptorAwareProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows, setInboundInterceptorFlows, setInboundInterceptorFlowsLookupStrategy, setOutboundInterceptorFlows, setOutboundInterceptorFlowsLookupStrategy

Methods inherited from class net.shibboleth.profile.config.AbstractConditionalProfileConfiguration

getActivationCondition, setActivationCondition

Methods inherited from class net.shibboleth.profile.config.AbstractProfileConfiguration

equals, getDisallowedFeatures, getSecurityConfiguration, hashCode, isFeatureDisallowed, setDisallowedFeatures, setDisallowedFeaturesLookupStrategy, setSecurityConfiguration, setSecurityConfigurationLookupStrategy

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.profile.config.ConditionalProfileConfiguration

getActivationCondition

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.idp.profile.config.InterceptorAwareProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows

Methods inherited from interface net.shibboleth.profile.config.ProfileConfiguration

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

Field Details

messageHandlerLookupStrategy

@Nonnull
private Function<MessageContext,Function<MessageContext,Exception>> messageHandlerLookupStrategy

Lookup strategy for message handler.

Constructor Details

AbstractOAuth2InterceptorAwareProfileConfiguration

public AbstractOAuth2InterceptorAwareProfileConfiguration(@Nonnull @NotEmpty
 String profileId)

Constructor.

Parameters:

profileId - Unique profile identifier.

Method Details

getMessageHandler

@Nullable
public Function<MessageContext,Exception> getMessageHandler(@Nullable
 MessageContext messageContext)

Get a custom handler for a message produced or consumed by this profile.

This function MUST be stateless and reusable if statically configured, or may be stateful if obtained by means of a more dynamic strategy.

The use of the Function API rather than the OpenSAML MessageHandler API is a concession to making scripted or otherwise non-Java implementations easily usable, and avoiding the explicit need to raise exceptions to signal errors, in cases where doing do is awkward.

Specified by:

getMessageHandler in interface OAuth2InterceptorAwareProfileConfiguration

Parameters:

messageContext - message context

Returns:

message handler

setMessageHandler

public void setMessageHandler(@Nullable
 Function<MessageContext,Exception> handler)

Set a handler for the message.

Parameters:

handler - message handler

Since:

3.2.0

setMessageHandlerLookupStrategy

public void setMessageHandlerLookupStrategy(@Nonnull
 Function<MessageContext,Function<MessageContext,Exception>> strategy)

Set a lookup strategy for the handler for the message.

Parameters:

strategy - lookup strategy

Since:

3.2.0