Package com.stackone.stackone_client_java.utils

Interface HTTPClient

All Known Implementing Classes:

RecordingClient, SpeakeasyHTTPClient

public interface HTTPClient

Method Summary

Modifier and Type	Method	Description
default void	enableDebugLogging(boolean enabled)	Controls the debug flag that can be used by clients to perform conditional debugging actions like logging HTTP requests and responses.
default boolean	isDebugLoggingEnabled()	Returns whether debug logging is enabled.
java.net.http.HttpResponse<java.io.InputStream>	send(java.net.http.HttpRequest request)	Sends an HTTP request and returns the response.

Method Detail

send

java.net.http.HttpResponse<java.io.InputStream> send(java.net.http.HttpRequest request)
                                              throws java.io.IOException,
                                                     java.lang.InterruptedException,
                                                     java.net.URISyntaxException

Sends an HTTP request and returns the response.

Note that HttpRequest is immutable. To modify the request you can use HttpRequest#newBuilder(HttpRequest, BiPredicate<String, String>) with JDK 16 and later (which will copy the request for modification in a builder). If that method is not available then use Helpers.copy(java.net.http.HttpRequest) (which also returns a builder).

Parameters:

request - HTTP request

Returns:

HTTP response

Throws:

java.io.IOException

java.lang.InterruptedException

java.net.URISyntaxException

enableDebugLogging

default void enableDebugLogging(boolean enabled)

Controls the debug flag that can be used by clients to perform conditional debugging actions like logging HTTP requests and responses. This is currently implemented in SpeakeasyHTTPClient but custom client implementations are free to use this method similarly if they wish.

Parameters:

enabled - Whether to enable debug flag

isDebugLoggingEnabled

default boolean isDebugLoggingEnabled()

Returns whether debug logging is enabled.

Returns:

Whether debug logging is enabled