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

Interface OAuth2InterceptorAwareProfileConfiguration

All Superinterfaces:

Component, ConditionalProfileConfiguration, IdentifiedComponent, InterceptorAwareProfileConfiguration, OAuth2ProfileConfiguration, ProfileConfiguration

All Known Implementing Classes:

AbstractOAuth2ClientAuthenticableProfileConfiguration, AbstractOAuth2FlowAwareProfileConfiguration, AbstractOAuth2InterceptorAwareProfileConfiguration, AbstractOAuth2TokenValidatingConfiguration, AbstractOIDCSSOConfiguration, DefaultOAuth2PushedAuthorizationRequestConfiguration, DefaultOAuth2TokenAudienceConfiguration, DefaultOAuth2TokenConfiguration, DefaultOAuth2TokenIntrospectionConfiguration, DefaultOAuth2TokenRevocationConfiguration, DefaultOIDCAuthorizationConfiguration, DefaultOIDCDynamicRegistrationConfiguration, DefaultOIDCLogoutConfiguration, DefaultOIDCUserInfoConfiguration

public interface OAuth2InterceptorAwareProfileConfiguration
extends OAuth2ProfileConfiguration, InterceptorAwareProfileConfiguration

Common interface for interceptor-aware OAuth 2.0 Profile Configurations.

Since:

3.2.0

Field Summary

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

DEFAULT_DISALLOWED_FEATURES

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.

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

Method Details

getMessageHandler

@ConfigurationSetting(name="messageHandler")
@Nullable
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.

Parameters:

messageContext - message context

Returns:

message handler