Interface OAuthCredentials.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OAuthCredentials.Builder,OAuthCredentials>, SdkBuilder<OAuthCredentials.Builder,OAuthCredentials>, SdkPojo
Enclosing class:
OAuthCredentials

public static interface OAuthCredentials.Builder extends SdkPojo, CopyableBuilder<OAuthCredentials.Builder,OAuthCredentials>
  • Method Details

    • clientId

      OAuthCredentials.Builder clientId(String clientId)

      The identifier for the desired client.

      Parameters:
      clientId - The identifier for the desired client.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientSecret

      OAuthCredentials.Builder clientSecret(String clientSecret)

      The client secret used by the OAuth client to authenticate to the authorization server.

      Parameters:
      clientSecret - The client secret used by the OAuth client to authenticate to the authorization server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • accessToken

      OAuthCredentials.Builder accessToken(String accessToken)

      The access token used to access protected SAPOData resources.

      Parameters:
      accessToken - The access token used to access protected SAPOData resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • refreshToken

      OAuthCredentials.Builder refreshToken(String refreshToken)

      The refresh token used to refresh expired access token.

      Parameters:
      refreshToken - The refresh token used to refresh expired access token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • oAuthRequest

      OAuthCredentials.Builder oAuthRequest(ConnectorOAuthRequest oAuthRequest)

      The OAuth requirement needed to request security tokens from the connector endpoint.

      Parameters:
      oAuthRequest - The OAuth requirement needed to request security tokens from the connector endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • oAuthRequest

      default OAuthCredentials.Builder oAuthRequest(Consumer<ConnectorOAuthRequest.Builder> oAuthRequest)

      The OAuth requirement needed to request security tokens from the connector endpoint.

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

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

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