Interface OAuth2UriProvider

  • All Known Implementing Classes:
    OAuth2UriProperty, OAuth2UriStatic

    public interface OAuth2UriProvider
    Provides URIs to the OAUTH2 authority.

    Rest Client (connector) creators may choose one of the existing factories:

    • OAuth2UriStatic: For simple 'implicit' OAUTH2 grants where an 'accessToken' can be leased directly with a 'clientId' and 'clientSecret'.
    • OAuth2UriProperty: For a factory that allows re-configuration of OAUTH2 URIs via Rest Client properties.
    Since:
    9.2
    API:
    This is a public API.
    • Method Detail

      • getTokenUri

        URI getTokenUri()
        Returns:
        an URI where clients can resolve an OAUTH2 'accessToken'.
        e.g. https://api.twitter.com/oauth2/token
        API:
        This public API is available in Java.
      • isAuthRequest

        boolean isAuthRequest​(URI uri)
        Indicates whether the current request is associated with an OAUTH2 request. E.g. an accessToken request initiated by a usage of the OAuth2BearerFilter.
        Parameters:
        uri - of the current REST client request
        Returns:
        true if the URI can be associated with a well known OAUTH2 uri.
        API:
        This public API is available in Java.