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 Details

  • 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.

    • getCustomPostLogoutRedirectUriValidationStrategy

      @ConfigurationSetting(name="customPostLogoutRedirectUriValidationStrategy") @Nullable BiPredicate<URI,ProfileRequestContext> getCustomPostLogoutRedirectUriValidationStrategy(@Nullable ProfileRequestContext profileRequestContext)
      Get the bi-predicate for validating post logout redirect URI in request to the current profile request context state.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      the bi-predicate for validating requested post logout redirect URI
      Since:
      3.4.0

    • isIgnoreInvalidPostLogoutRedirectUri

      @ConfigurationSetting(name="ignoreInvalidPostLogoutRedirectUri") boolean isIgnoreInvalidPostLogoutRedirectUri(@Nullable ProfileRequestContext profileRequestContext)
      Get whether to ignore invalid post logout redirect URI in the request.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      true if an invalid post logout redirect URI is to be ignored
      Since:
      3.4.0

    • getHttpRequestMethod

      @ConfigurationSetting(name="httpRequestMethod") @Nullable default OAuth2AuthorizationProfileConfiguration.HttpRequestMethod getHttpRequestMethod(@Nullable ProfileRequestContext profileRequestContext)
      Get the HTTP request method for an RP-Initiated logout request.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      the HTTP request method TODO: remove the default in version 4.0.0
      Since:
      3.4.0

    • getLogoutHintClaim

      @ConfigurationSetting(name="logoutHintClaim") @Nullable default String getLogoutHintClaim(@Nullable ProfileRequestContext profileRequestContext)
      Get the ID Token claim whose value should be used as the logout_hint parameter in an RP-Initiated Logout request.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      the claim name, or null if no logout_hint should be supplied TODO: remove the default implementation in version 4.0.0
      Since:
      3.4.0

    • isIncludePostLogoutRedirectUri

      @ConfigurationSetting(name="includePostLogoutRedirectUri") default boolean isIncludePostLogoutRedirectUri(@Nullable ProfileRequestContext profileRequestContext)
      Get whether post_logout_redirect_uri is included in an OIDC RP-Initiated logout request.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      true if the post_logout_redirect_uri parameter should be included in the request, false otherwise. TODO: remove the default implementation in version 4.0.0
      Since:
      3.4.0