jio.http.client.oauth.OauthHttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jio-http Show documentation

Functional and reactive http client in Java

There is a newer version: 3.0.0-RC1

package jio.http.client.oauth;

import jio.http.client.HttpLambda;
import jio.http.client.JioHttpClient;

import java.net.http.HttpResponse;

/**
 * An HTTP client with support for OAuth Client Credentials Grant. This client allows you to make HTTP requests with
 * OAuth authentication using the Client Credentials Grant flow. It automatically handles access token expiration and
 * refreshes tokens when needed.
 */
public interface OauthHttpClient extends JioHttpClient {

  /**
   * Http lambda that takes a req builder, send the request asynchronously to the server and wrap the response into a
   * http response, requesting an access token when necessary and parsing the body response into a string.
   *
   * @return a http lambda
   */
  HttpLambda oauthOfString();

  /**
   * Http lambda that takes a req builder, send the request asynchronously to the server and wrap the response into a
   * http response, requesting an access token when necessary and parsing the body response into an array of bytes
   *
   * @return a http lambda
   */
  HttpLambda oauthOfBytes();

  /**
   * Http lambda that takes a req builder, send the request asynchronously to the server and wrap the response into a
   * http response, requesting an access token when necessary  and discarding the body response
   *
   * @return a http lambda
   */
  HttpLambda oauthDiscarding();

  /**
   * HttpLambda that takes a request builder and returns a JIO effect with the http response, parsing the body with the
   * given handler and requesting an access token when necessary. There are different predefined http lambdas in this
   * class to parse the most common types: {@link #ofString strings} and {@link #ofBytes()} etc
   *
   * @param handler the body response handler
   * @param      the response body type
   * @return a new HttpLambda
   * @see HttpResponse.BodyHandlers for more body handlers implementations
   */
   HttpLambda oauthBodyHandler(final HttpResponse.BodyHandler handler);


}