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

Class AbstractOAuth2FlowAwareProfileConfiguration

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

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

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

All Implemented Interfaces:

AuthenticationProfileConfiguration, InterceptorAwareProfileConfiguration, OIDCFlowAwareProfileConfiguration, OIDCProfileConfiguration, OAuth2ClientAuthenticableClientProfileConfiguration, OAuth2ClientAuthenticableProfileConfiguration, OAuth2DPoPProofValidatingProfileConfiguration, OAuth2FlowAwareProfileConfiguration, OAuth2InterceptorAwareProfileConfiguration, OAuth2ProfileConfiguration, ConditionalProfileConfiguration, ProfileConfiguration, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

AbstractOIDCSSOConfiguration, DefaultOIDCDynamicRegistrationConfiguration

public abstract class AbstractOAuth2FlowAwareProfileConfiguration
extends AbstractOAuth2ClientAuthenticableProfileConfiguration
implements OIDCFlowAwareProfileConfiguration, OAuth2FlowAwareProfileConfiguration

Base class for OIDC protocol configuration, containing configuration bits shared by all flow aware OIDC protocol configurations.

Field Summary

Fields

Modifier and Type	Field	Description
private Predicate<ProfileRequestContext>	authorizationCodeFlowPredicate	Predicate used to indicate whether authorization code flow is supported by this profile.
private Predicate<ProfileRequestContext>	hybridFlowPredicate	Predicate used to indicate whether hybrid flow is supported by this profile.
private Predicate<ProfileRequestContext>	implicitFlowPredicate	Predicate used to indicate whether implicit flow is supported by this profile.
private Predicate<ProfileRequestContext>	refreshTokensPredicate	Predicate used to indicate whether refresh tokens are supported by this profile.

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

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOAuth2FlowAwareProfileConfiguration(String profileId)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	isAuthorizationCodeFlowEnabled(ProfileRequestContext profileRequestContext)	Get whether authorization code flow is supported by this profile.
boolean	isHybridFlowEnabled(ProfileRequestContext profileRequestContext)	Get whether the implicit flow is supported by this profile.
boolean	isImplicitFlowEnabled(ProfileRequestContext profileRequestContext)	Get whether hybrid flow is supported by this profile.
boolean	isRefreshTokensEnabled(ProfileRequestContext profileRequestContext)	Get whether refresh tokens are supported by this profile.
void	setAuthorizationCodeFlowEnabled(boolean flag)	Set whether authorization code flow is supported by this profile.
void	setAuthorizationCodeFlowEnabledPredicate(Predicate<ProfileRequestContext> condition)	Set condition used to indicate whether authorization code flow is supported by this profile.
void	setHybridFlowEnabled(boolean flag)	Set whether implicit flow is supported by this profile.
void	setHybridFlowEnabledPredicate(Predicate<ProfileRequestContext> condition)	Set condition used to indicate whether implicit flow is supported by this profile.
void	setImplicitFlowEnabled(boolean flag)	Set whether hybrid flow is supported by this profile.
void	setImplicitFlowEnabledPredicate(Predicate<ProfileRequestContext> condition)	Set condition used to indicate whether hybrid flow is supported by this profile.
void	setRefreshTokensEnabled(boolean flag)	Set whether refresh tokens are supported by this profile.
void	setRefreshTokensEnabledPredicate(Predicate<ProfileRequestContext> condition)	Set condition used to indicate whether refresh tokens are supported by this profile.

Methods inherited from class net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2ClientAuthenticableProfileConfiguration

getAuthenticationFlows, getClaimsValidator, getClientCredential, getClientId, getDefaultAuthenticationMethods, getDpopProofClaimsValidator, getDpopProofNonceGenerator, getDpopProofSignatureValidationConfiguration, getPostAuthenticationFlows, getProxyCount, getTokenEndpointAuthMethod, getTokenEndpointAuthMethods, getUnregisteredClientPolicy, isForceAuthn, isRequireDpopProof, setAuthenticationFlows, setAuthenticationFlowsLookupStrategy, setClaimsValidator, setClaimsValidatorLookupStrategy, setClientCredential, setClientCredentialLookupStrategy, setClientId, setClientIdLookupStrategy, setDefaultAuthenticationMethods, setDefaultAuthenticationMethodsLookupStrategy, setDpopProofClaimsValidator, setDpopProofClaimsValidatorLookupStrategy, setDpopProofNonceGenerator, setDpopProofNonceGeneratorLookupStrategy, setDpopProofSignatureValidationConfiguration, setDpopProofSignatureValidationConfigurationLookupStrategy, setForceAuthn, setForceAuthnPredicate, setPostAuthenticationFlows, setPostAuthenticationFlowsLookupStrategy, setProxyCount, setProxyCountLookupStrategy, setRequireDpopProof, setRequireDpopProofPredicate, setTokenEndpointAuthMethod, setTokenEndpointAuthMethodLookupStrategy, setTokenEndpointAuthMethods, setTokenEndpointAuthMethodsLookupStrategy, setUnregisteredClientPolicy, setUnregisteredClientPolicyLookupStrategy

Methods inherited from class net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2InterceptorAwareProfileConfiguration

getMessageHandler, setMessageHandler, setMessageHandlerLookupStrategy

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.idp.authn.config.AuthenticationProfileConfiguration

isLocal

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

authorizationCodeFlowPredicate

@Nonnull
private Predicate<ProfileRequestContext> authorizationCodeFlowPredicate

Predicate used to indicate whether authorization code flow is supported by this profile. Default true.

implicitFlowPredicate

@Nonnull
private Predicate<ProfileRequestContext> implicitFlowPredicate

Predicate used to indicate whether implicit flow is supported by this profile. Default true.

hybridFlowPredicate

@Nonnull
private Predicate<ProfileRequestContext> hybridFlowPredicate

Predicate used to indicate whether hybrid flow is supported by this profile. Default true.

refreshTokensPredicate

@Nonnull
private Predicate<ProfileRequestContext> refreshTokensPredicate

Predicate used to indicate whether refresh tokens are supported by this profile. Default true.

Constructor Details

AbstractOAuth2FlowAwareProfileConfiguration

protected AbstractOAuth2FlowAwareProfileConfiguration(@Nonnull @NotEmpty
 String profileId)

Constructor.

Parameters:

profileId - Unique profile identifier.

Method Details

isAuthorizationCodeFlowEnabled

public boolean isAuthorizationCodeFlowEnabled(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether authorization code flow is supported by this profile.

Specified by:

isAuthorizationCodeFlowEnabled in interface OAuth2FlowAwareProfileConfiguration

Parameters:

profileRequestContext - profile request context

Returns:

whether authorization code flow is supported by this profile

setAuthorizationCodeFlowEnabled

public void setAuthorizationCodeFlowEnabled(boolean flag)

Set whether authorization code flow is supported by this profile.

Parameters:

flag - flag to set

setAuthorizationCodeFlowEnabledPredicate

public void setAuthorizationCodeFlowEnabledPredicate(@Nonnull
 Predicate<ProfileRequestContext> condition)

Set condition used to indicate whether authorization code flow is supported by this profile.

Parameters:

condition - condition to set

isHybridFlowEnabled

public boolean isHybridFlowEnabled(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether the implicit flow is supported by this profile.

Specified by:

isHybridFlowEnabled in interface OIDCFlowAwareProfileConfiguration

Parameters:

profileRequestContext - profile request context

Returns:

whether implicit flow is supported by this profile

setHybridFlowEnabled

public void setHybridFlowEnabled(boolean flag)

Set whether implicit flow is supported by this profile.

Parameters:

flag - flag to set

setHybridFlowEnabledPredicate

public void setHybridFlowEnabledPredicate(@Nonnull
 Predicate<ProfileRequestContext> condition)

Set condition used to indicate whether implicit flow is supported by this profile.

Parameters:

condition - condition to set

isImplicitFlowEnabled

public boolean isImplicitFlowEnabled(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether hybrid flow is supported by this profile.

Specified by:

isImplicitFlowEnabled in interface OAuth2FlowAwareProfileConfiguration

Parameters:

profileRequestContext - profile request context

Returns:

whether hybrid flow is supported by this profile

setImplicitFlowEnabled

public void setImplicitFlowEnabled(boolean flag)

Set whether hybrid flow is supported by this profile.

Parameters:

flag - flag to set

setImplicitFlowEnabledPredicate

public void setImplicitFlowEnabledPredicate(@Nonnull
 Predicate<ProfileRequestContext> condition)

Set condition used to indicate whether hybrid flow is supported by this profile.

Parameters:

condition - condition to set.

isRefreshTokensEnabled

public boolean isRefreshTokensEnabled(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether refresh tokens are supported by this profile.

Specified by:

isRefreshTokensEnabled in interface OAuth2FlowAwareProfileConfiguration

Parameters:

profileRequestContext - profile request context

Returns:

whether refresh tokens are supported by this profile

setRefreshTokensEnabled

public void setRefreshTokensEnabled(boolean flag)

Set whether refresh tokens are supported by this profile.

Parameters:

flag - flag to set

setRefreshTokensEnabledPredicate

public void setRefreshTokensEnabledPredicate(@Nonnull
 Predicate<ProfileRequestContext> condition)

Set condition used to indicate whether refresh tokens are supported by this profile.

Parameters:

condition - condition to set