Package com.sap.cloud.sdk.cloudplatform.connectivity

Interface OAuth2PropertySupplier

All Known Implementing Classes:
DefaultOAuth2PropertySupplier
@Beta public interface OAuth2PropertySupplier
A supplier of OAuth client information. Implementations should extract the client information out of a ServiceBinding.
Since:
4.20.0

  • Method Summary

    Modifier and Type
    Method
    Description
    com.sap.cloud.security.config.ClientIdentity
    getClientIdentity()
    OAuth client identity to be used for obtaining a token.
    default OAuth2Options
    getOAuth2Options()
    Returns additional configuration for the OAuth2 destination that is to be created.
    URI
    getServiceUri()
    URL that the OAuth client should authenticate to.
    URI
    getTokenUri()
    URL of the OAuth token service.
    boolean
    isOAuth2Binding()
    Indicates if the binding is supported by this supplier.

  • Method Details

    • isOAuth2Binding

      boolean isOAuth2Binding()
      Indicates if the binding is supported by this supplier.
      Returns:
      True, if the binding appears to be an OAuth binding and this property supplier is capable of parsing it.

    • getServiceUri

      @Nonnull URI getServiceUri()
      URL that the OAuth client should authenticate to.
      Returns:
      A valid URI.

    • getTokenUri

      @Nonnull URI getTokenUri()
      URL of the OAuth token service.
      Returns:
      A valid URI.

    • getClientIdentity

      @Nonnull com.sap.cloud.security.config.ClientIdentity getClientIdentity()
      OAuth client identity to be used for obtaining a token.
      Returns:
      a ClientIdentity.

    • getOAuth2Options

      @Nonnull default OAuth2Options getOAuth2Options()
      Returns additional configuration for the OAuth2 destination that is to be created. By default, this method returns OAuth2Options.DEFAULT.
      Returns:
      An instance of OAuth2Options to further customize the OAuth2 destination creation.
      Since:
      5.5.0