Package net.shibboleth.oidc.profile.config

Interface OIDCLogoutProfileConfiguration

All Superinterfaces:

Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ProfileConfiguration, OAuth2TokenEncryptionProfileConfiguration, OIDCProfileConfiguration, ProfileConfiguration

All Known Implementing Classes:

DefaultOIDCLogoutConfiguration

public interface OIDCLogoutProfileConfiguration
extends OAuth2TokenEncryptionProfileConfiguration

Configuration for IdP OpenID Connect Logout.

Since:

3.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROFILE_ID	ID for this profile configuration.

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

DEFAULT_DISALLOWED_FEATURES

Method Summary

Modifier and Type	Method	Description
BiPredicate<String,SPSession>	getLogoutHintMatchingStrategy(ProfileRequestContext profileRequestContext)	Get the bi-predicate for matching logout hint to an existing session in an OIDC RP-initiated logout sequence.
boolean	isFrontChannelSuccess(ProfileRequestContext profileRequestContext)	Get whether to consider front-channel logout propagation successful.
boolean	isPreferFrontChannel(ProfileRequestContext profileRequestContext)	Get whether to prefer front-channel if both are defined for the RP.
boolean	isRequireIdTokenHint(ProfileRequestContext profileRequestContext)	Get whether to require the use of id_token_hint in an OIDC RP-initiated logout sequence.
boolean	isRevokeTokens(ProfileRequestContext profileRequestContext)	Get whether to revoke the tokens related to the session to be logged out.

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.oidc.profile.oauth2.config.OAuth2TokenEncryptionProfileConfiguration

isEncryptionOptional

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

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

Field Details

PROFILE_ID

@Nonnull
@NotEmpty
static final String PROFILE_ID

ID for this profile configuration.

See Also:

• Constant Field Values

Method Details

isPreferFrontChannel

@ConfigurationSetting(name="preferFrontChannel")
boolean isPreferFrontChannel(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether to prefer front-channel if both are defined for the RP.

Parameters:

profileRequestContext - current profile request context

Returns:

true iff front-channel is to be preferred

isFrontChannelSuccess

@ConfigurationSetting(name="frontChannelSuccess")
boolean isFrontChannelSuccess(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether to consider front-channel logout propagation successful.

Parameters:

profileRequestContext - current profile request context

Returns:

true iff front-channel propagation considered as successful

isRevokeTokens

@ConfigurationSetting(name="revokeTokens")
boolean isRevokeTokens(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether to revoke the tokens related to the session to be logged out.

Parameters:

profileRequestContext - current profile request context

Returns:

true iff the tokens are to be revoked

isRequireIdTokenHint

@ConfigurationSetting(name="requireIdTokenHint")
boolean isRequireIdTokenHint(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether to require the use of id_token_hint in an OIDC RP-initiated logout sequence.

Parameters:

profileRequestContext - profile request context

Returns:

true iff the use of id_token_hint is required

getLogoutHintMatchingStrategy

@ConfigurationSetting(name="logoutHintMatchingStrategy")
@Nullable
BiPredicate<String,SPSession> getLogoutHintMatchingStrategy(@Nullable
 ProfileRequestContext profileRequestContext)

Get the bi-predicate for matching logout hint to an existing session in an OIDC RP-initiated logout sequence.

Parameters:

profileRequestContext - profile request context

Returns:

the bi-predicate for matching logout hint to an existing session.