Package com.auth0.net.client

Class DefaultHttpClient

java.lang.Object

com.auth0.net.client.DefaultHttpClient

All Implemented Interfaces:

Auth0HttpClient

public class DefaultHttpClient
extends Object
implements Auth0HttpClient

Default implementation of Auth0HttpClient responsible for performing HTTP requests to the Auth0 APIs. Instances can be configured and created using the DefaultHttpClient.Builder.

To minimize resource usage, instances should be created once and used in both the ManagementAPI and AuthAPI API clients.

For most use cases, usage of this client is recommended. If you have more advanced use cases, such as the need to re-use an existing HTTP client, you may consider providing a custom implementation of Auth0HttpClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultHttpClient.Builder	Builder for DefaultHttpClient instances.

Method Summary

Modifier and Type	Method	Description
static DefaultHttpClient.Builder	newBuilder()
Auth0HttpResponse	sendRequest(Auth0HttpRequest request)	Builds, executes, and returns the result of a synchronous HTTP request to an Auth0 API.
CompletableFuture<Auth0HttpResponse>	sendRequestAsync(Auth0HttpRequest request)	Builds and executes an asynchronous HTTP request to an Auth0 API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newBuilder

public static DefaultHttpClient.Builder newBuilder()

sendRequest

public Auth0HttpResponse sendRequest(Auth0HttpRequest request)
                              throws IOException

Description copied from interface: Auth0HttpClient

Builds, executes, and returns the result of a synchronous HTTP request to an Auth0 API.

Specified by:

sendRequest in interface Auth0HttpClient

Parameters:

request - the request to send.

Returns:

the response returned by the executed request.

Throws:

IOException - if the request can not be completed due to a network timeout or interruption.

sendRequestAsync

public CompletableFuture<Auth0HttpResponse> sendRequestAsync(Auth0HttpRequest request)

Description copied from interface: Auth0HttpClient

Builds and executes an asynchronous HTTP request to an Auth0 API.

Specified by:

sendRequestAsync in interface Auth0HttpClient

Parameters:

request - the request to send.

Returns:

the CompletableFuture that represents the result of the asynchronous HTTP request.