Interface OAuthConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OAuthConfig.Builder,OAuthConfig>, SdkBuilder<OAuthConfig.Builder,OAuthConfig>, SdkPojo
Enclosing class:
OAuthConfig
@Mutable @NotThreadSafe public static interface OAuthConfig.Builder extends SdkPojo, CopyableBuilder<OAuthConfig.Builder,OAuthConfig>

  • Method Details

    • authUrl

      OAuthConfig.Builder authUrl(String authUrl)

      The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

      Parameters:
      authUrl - The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenUrl

      OAuthConfig.Builder tokenUrl(String tokenUrl)

      The token URL for the OAuth service, where authorization codes are exchanged for access tokens.

      Parameters:
      tokenUrl - The token URL for the OAuth service, where authorization codes are exchanged for access tokens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      OAuthConfig.Builder scope(String scope)

      The OAuth scopes requested during authorization, which define the permissions granted to the application.

      Parameters:
      scope - The OAuth scopes requested during authorization, which define the permissions granted to the application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenEndpointAuthenticationScheme

      OAuthConfig.Builder tokenEndpointAuthenticationScheme(String tokenEndpointAuthenticationScheme)

      The authentication scheme used when requesting tokens from the token endpoint.

      Parameters:
      tokenEndpointAuthenticationScheme - The authentication scheme used when requesting tokens from the token endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tokenEndpointAuthenticationScheme

      OAuthConfig.Builder tokenEndpointAuthenticationScheme(TokenEndpointAuthenticationScheme tokenEndpointAuthenticationScheme)

      The authentication scheme used when requesting tokens from the token endpoint.

      Parameters:
      tokenEndpointAuthenticationScheme - The authentication scheme used when requesting tokens from the token endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • oAuthCompleteRedirectUrl

      OAuthConfig.Builder oAuthCompleteRedirectUrl(String oAuthCompleteRedirectUrl)

      The URL where users are redirected after completing the OAuth authorization process.

      Parameters:
      oAuthCompleteRedirectUrl - The URL where users are redirected after completing the OAuth authorization process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proactiveRefreshTokenRenewal

      OAuthConfig.Builder proactiveRefreshTokenRenewal(ProactiveRefreshTokenRenewal proactiveRefreshTokenRenewal)

      Configuration for proactively refreshing OAuth tokens before they expire.

      Parameters:
      proactiveRefreshTokenRenewal - Configuration for proactively refreshing OAuth tokens before they expire.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proactiveRefreshTokenRenewal

      default OAuthConfig.Builder proactiveRefreshTokenRenewal(Consumer<ProactiveRefreshTokenRenewal.Builder> proactiveRefreshTokenRenewal)

      Configuration for proactively refreshing OAuth tokens before they expire.

      This is a convenience method that creates an instance of the ProactiveRefreshTokenRenewal.Builder avoiding the need to create one manually via ProactiveRefreshTokenRenewal.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to proactiveRefreshTokenRenewal(ProactiveRefreshTokenRenewal).

      Parameters:
      proactiveRefreshTokenRenewal - a consumer that will call methods on ProactiveRefreshTokenRenewal.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: