Interface OAuth2AccessTokenProducingProfileConfiguration

All Superinterfaces:
Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ProfileConfiguration, ProfileConfiguration
All Known Subinterfaces:
OAuth2TokenAudienceConfiguration, OAuth2TokenConfiguration, OIDCAuthorizationConfiguration, OIDCSSOProviderConfiguration
All Known Implementing Classes:
AbstractOIDCSSOConfiguration, DefaultOAuth2PushedAuthorizationRequestConfiguration, DefaultOAuth2TokenAudienceConfiguration, DefaultOAuth2TokenConfiguration, DefaultOIDCAuthorizationConfiguration

public interface OAuth2AccessTokenProducingProfileConfiguration extends OAuth2ProfileConfiguration
Configuration common to OAuth 2.0 access token producing profiles.
  • Method Details

    • getAccessTokenType

      @ConfigurationSetting(name="accessTokenType") @Nullable @NotEmpty String getAccessTokenType(@Nullable ProfileRequestContext profileRequestContext)
      Get access token type.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      access token type, or null for unspecified/opaque
      Since:
      2.1.0
    • getAccessTokenLifetime

      @ConfigurationSetting(name="accessTokenLifetime") @Positive @Nonnull Duration getAccessTokenLifetime(@Nullable ProfileRequestContext profileRequestContext)
      Get access token lifetime.

      Defaults to 10 minutes.

      Parameters:
      profileRequestContext - profile request context
      Returns:
      access token lifetime
    • getAccessTokenClaimsSetManipulationStrategy

      @ConfigurationSetting(name="accessTokenClaimsSetManipulationStrategy") @Nullable BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>> getAccessTokenClaimsSetManipulationStrategy(@Nullable ProfileRequestContext profileRequestContext)
      Get the bi-function for manipulating access token claims set.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      the bi-function for manipulating access token claims set
      Since:
      2.1.0
    • isAlwaysIssueBearerAccessToken

      @ConfigurationSetting(name="alwaysIssueBearerAccessToken") boolean isAlwaysIssueBearerAccessToken(@Nullable ProfileRequestContext profileRequestContext)
      Get whether the access token to be issued is always a bearer access token.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      whether the access token to be issued is always a bearer access token
      Since:
      3.2.0