Package com.storedobject.common

Class HTTP2.Builder

java.lang.Object

com.storedobject.common.HTTP2.Builder

Enclosing class:

HTTP2

public static class HTTP2.Builder
extends Object

This class provides a builder pattern for constructing HTTP requests. It allows customization of various aspects such as URL, headers, body, timeouts, and other configurations related to the HTTP client and requests. The builder also supports synchronous and asynchronous operations for request execution.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HTTP2.Builder	accept(String accept)	Sets the "Accept" header to specify the media types that the client can process.
HTTP2.Builder	acceptAny()	Configures the builder to accept any media type by setting the "Accept" header to "
HTTP2.Builder	acceptJSON()	Sets the "Accept" header of the HTTP request to "application/json".
HTTP2.Builder	acceptXML()	Configures the builder to accept responses with a MIME type of "application/xml".
HTTP2.Builder	authenticator(Authenticator authenticator)	Configures the HTTP client with a custom authenticator.
HTTP2.Builder	bearerToken(String token)	Sets the Authorization header with a Bearer token.
HTTP2.Builder	body(String body)	Sets the body content for the request and returns the builder instance for chaining.
HTTP2.Builder	contentType(String contentType)	Sets the "Content-Type" header for the request.
HTTP2.Builder	contentTypeForm()	Sets the Content-Type header to "application/x-www-form-urlencoded; charset=UTF-8".
HTTP2.Builder	contentTypeJSON()	Sets the Content-Type header to "application/json" and the Accept header to "application/json; charset=UTF-8".
HTTP2.Builder	contentTypeXML()	Sets the "Content-Type" header to "application/xml" and the "Accept" header to "application/xml; charset=UTF-8" for the current request.
HttpClient.Builder	getClientBuilder()	Retrieves or initializes the HttpClient.Builder instance for configuring and building HttpClient objects.
Exception	getException()
HTTP2.Builder	header(String key, String value)	Adds a header to the request being built.
HTTP2.Builder	headers(Map<String,String> headers)	Sets a collection of headers for the request by iterating over the provided map and adding each key-value pair as a header.
JSON	json()	Retrieves and converts the response content to a JSON object.
HTTP2.Builder	localAddress(InetAddress address)	Sets the local address for the HTTP client.
HTTP2.Builder	proxy(ProxySelector proxy)	Configures the HTTP client to use the specified ProxySelector for proxy settings.
HTTP2.Builder	requestCustomizer(Consumer<HttpRequest.Builder> requestCustomizer)	Adds a customizer for the HTTP request being built.
HttpResponse<InputStream>	response()	Retrieves the HTTP response as an HttpResponse containing the InputStream.
HTTP2.Builder	sslContext(SSLContext sslContext)	Configures the SSLContext to be used by the HTTP client.
HTTP2.Builder	sslParameters(SSLParameters sslParameters)	Configures the SSL parameters to be used for HTTPS connections in the request.
int	statusCode()	Retrieves the HTTP status code from the response object.
InputStream	stream()	Retrieves the InputStream representation of the response generated by the associated HTTP2 call.
CompletableFuture<InputStream>	streamAsync()	Asynchronously retrieves the HTTP response body as an InputStream.
String	string()	Retrieves and converts the response content stream into a string representation.
CompletableFuture<String>	stringAsync()	Asynchronously retrieves the response body as a string.
HTTP2.Builder	timeout(Duration timeout)	Sets the timeout duration for the HTTP request.
HTTP2.Builder	url(String url)	Sets the URL for the HTTP request.
XML	xml()	Retrieves and converts the response content, set to an XML content type, into an XML object.
CompletableFuture<XML>	xmlAsync()	Asynchronously retrieves the response and parses it as an XML object.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

url

public HTTP2.Builder url(String url)

Sets the URL for the HTTP request.

Parameters:

url - the URL to be set for the request

Returns:

the updated builder instance

authenticator

public HTTP2.Builder authenticator(Authenticator authenticator)

Configures the HTTP client with a custom authenticator.

Parameters:

authenticator - the Authenticator instance to handle authentication for requests

Returns:

the updated Builder instance for method chaining

requestCustomizer

public HTTP2.Builder requestCustomizer(Consumer<HttpRequest.Builder> requestCustomizer)

Adds a customizer for the HTTP request being built. This method allows chaining multiple customizers by combining them into a composite customizer if needed.

Parameters:

requestCustomizer - a Consumer implementation that applies customizations to an HttpRequest.Builder instance.

Returns:

the Builder instance, enabling method chaining.

body

public HTTP2.Builder body(String body)

Sets the body content for the request and returns the builder instance for chaining.

Parameters:

body - the body content to be included in the request

Returns:

the Builder instance for method chaining

timeout

public HTTP2.Builder timeout(Duration timeout)

Sets the timeout duration for the HTTP request.

Parameters:

timeout - the timeout duration to be applied to the HTTP request

Returns:

the Builder instance for method chaining

header

public HTTP2.Builder header(String key,
 String value)

Adds a header to the request being built. If the headers map is null, it initializes the map and adds the key-value pair. Otherwise, it simply adds or updates the key-value pair in the existing headers map.

Parameters:

key - the header name

value - the header value

Returns:

the current Builder instance for method chaining

headers

public HTTP2.Builder headers(Map<String,String> headers)

Sets a collection of headers for the request by iterating over the provided map and adding each key-value pair as a header.

Parameters:

headers - a map containing the headers to be added, where the keys are the header names and the values are the corresponding header values

Returns:

the current Builder instance for method chaining

bearerToken

public HTTP2.Builder bearerToken(String token)

Sets the Authorization header with a Bearer token.

Parameters:

token - the Bearer token to be used in the Authorization header

Returns:

the Builder instance with the updated Authorization header

contentType

public HTTP2.Builder contentType(String contentType)

Sets the "Content-Type" header for the request.

Parameters:

contentType - the value of the "Content-Type" header to be set

Returns:

the current instance of the Builder for method chaining

contentTypeXML

public HTTP2.Builder contentTypeXML()

Sets the "Content-Type" header to "application/xml" and the "Accept" header to "application/xml; charset=UTF-8" for the current request.

Returns:

this builder instance with updated headers, allowing method chaining

contentTypeJSON

public HTTP2.Builder contentTypeJSON()

Sets the Content-Type header to "application/json" and the Accept header to "application/json; charset=UTF-8".

Returns:

the updated Builder instance for method chaining

contentTypeForm

public HTTP2.Builder contentTypeForm()

Sets the Content-Type header to "application/x-www-form-urlencoded; charset=UTF-8".

Returns:

the Builder instance with the updated Content-Type header.

accept

public HTTP2.Builder accept(String accept)

Sets the "Accept" header to specify the media types that the client can process.

Parameters:

accept - the value of the "Accept" header, defining the desired media types.

Returns:

the current Builder instance for method chaining.

acceptXML

public HTTP2.Builder acceptXML()

Configures the builder to accept responses with a MIME type of "application/xml".

Returns:

the updated Builder instance configured to accept "application/xml" responses.

acceptJSON

public HTTP2.Builder acceptJSON()

Sets the "Accept" header of the HTTP request to "application/json".

Returns:

the updated Builder instance

acceptAny

public HTTP2.Builder acceptAny()

Configures the builder to accept any media type by setting the "Accept" header to "

sslContext

public HTTP2.Builder sslContext(SSLContext sslContext)

Configures the SSLContext to be used by the HTTP client.

Parameters:

sslContext - the SSLContext instance to be used for secure HTTPS connections. If null is passed it will be ignored.

Returns:

the current Builder instance for method chaining

sslParameters

public HTTP2.Builder sslParameters(SSLParameters sslParameters)

Configures the SSL parameters to be used for HTTPS connections in the request.

Parameters:

sslParameters - the SSLParameters instance to configure SSL settings If null is passed it will be ignored.

Returns:

the updated Builder instance for method chaining

proxy

public HTTP2.Builder proxy(ProxySelector proxy)

Configures the HTTP client to use the specified ProxySelector for proxy settings. The proxy selector determines the proxy to use for a given HTTP request.

Parameters:

proxy - the ProxySelector instance to configure proxy settings for the HTTP client If null is passed it will be ignored.

Returns:

the current Builder instance for method chaining

localAddress

public HTTP2.Builder localAddress(InetAddress address)

Sets the local address for the HTTP client. This is used to specify the network interface from which the connection will be made.

Parameters:

address - the InetAddress representing the local address or network interface to bind to. If null is passed it will be ignored.

Returns:

the updated Builder instance for method chaining.

response

public HttpResponse<InputStream> response()

Retrieves the HTTP response as an HttpResponse containing the InputStream.

Note: If you invoke this method before using any of the retrieval methods such as string(), xml(), json() or its async cousins, the result will be null.

Warning: The InputStream instance of this is not useful because it is already fully read by the time this is available. However, the response can be used to check other details of the response.

Returns:

the HTTP response that wraps an InputStream, providing the body of the HTTP response.

statusCode

public int statusCode()

Retrieves the HTTP status code from the response object. If the response is null, it returns -1.

Note: If you invoke this method before using any of the retrieval methods such as string(), xml(), json() or its async cousins, the result will be -1.

Returns:

the HTTP status code of the response, or -1 if the response is null

string

public String string()
              throws Exception

Retrieves and converts the response content stream into a string representation.

Returns:

the string representation of the response content

Throws:

Exception - if an error occurs while processing the stream

stringAsync

public CompletableFuture<String> stringAsync()

Asynchronously retrieves the response body as a string.

Returns:

A CompletableFuture containing the response body as a String. The CompletableFuture can be completed normally with the response body or exceptionally if an error occurs.

stream

public InputStream stream()

Retrieves the InputStream representation of the response generated by the associated HTTP2 call. In the event of an exception during the execution of the HTTP2 stream, this method returns null.

Returns:

an InputStream containing the HTTP2 response body, or null if an exception occurs

xml

public XML xml()

Retrieves and converts the response content, set to an XML content type, into an XML object.

Returns:

an XML object representation of the response content

streamAsync

public CompletableFuture<InputStream> streamAsync()

Asynchronously retrieves the HTTP response body as an InputStream.

Returns:

a CompletableFuture representing the asynchronous computation of the HTTP response body streamed as an InputStream.

xmlAsync

public CompletableFuture<XML> xmlAsync()

Asynchronously retrieves the response and parses it as an XML object. This method sets the Content-Type of the request to application/xml and invokes the XML parsing logic.

Returns:

a CompletableFuture that completes with the parsed XML object representing the server's response, or completes exceptionally if an error occurs during the request or parsing.

json

public JSON json()

Retrieves and converts the response content to a JSON object.

Returns:

a JSON object representing the parsed response content

getException

public Exception getException()

getClientBuilder

public HttpClient.Builder getClientBuilder()

Retrieves or initializes the HttpClient.Builder instance for configuring and building HttpClient objects. If the httpClientBuilder is null, this method initializes it.

Note: If this method is invoked a custom client builder is created that you can manipulate directly. It will not affect any other connections of HTTP2.

Warning: Make sure that you don't call the HttpClient.Builder.build() method on the instance returned by this. It will be automatically called internally when required.

Returns:

the HttpClient.Builder instance, either existing or newly constructed.