Package com.intellectualsites.http

Class HttpClient.WrappedRequestBuilder

java.lang.Object

com.intellectualsites.http.HttpClient.WrappedRequestBuilder

Enclosing class:

HttpClient

public final class HttpClient.WrappedRequestBuilder
extends Object

Wrapper used to interact with HTTP requests.

See Also:

To create a new GET request, To create a new POST request, To create a new HEAD request, To create a new PUT request, To create a new PATCH request, To create a new DELETE request

Method Summary

Modifier and Type	Method	Description
@Nullable HttpResponse	execute()	Perform the request
@NotNull HttpClient.WrappedRequestBuilder	onException(@NotNull Consumer<Throwable> consumer)	Add an exception consumer
@NotNull HttpClient.WrappedRequestBuilder	onRemaining(@NotNull Consumer<HttpResponse> responseConsumer)	Add a consumer that acts on all remaining status code
@NotNull HttpClient.WrappedRequestBuilder	onStatus(int code, @NotNull Consumer<HttpResponse> responseConsumer)	Add a consumer that acts on a specific status code
@NotNull HttpClient.WrappedRequestBuilder	withHeader(@NotNull String key, @NotNull String value)	Add a header to the request
@NotNull HttpClient.WrappedRequestBuilder	withInput(@NotNull Supplier<Object> input)	Specify an input supplier which will be used to write to the connection, if it established correctly.
@NotNull HttpClient.WrappedRequestBuilder	withMapper(@NotNull EntityMapper mapper)	Specify the entity mapper used by the request

Methods inherited from class java.lang.Object

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

Method Details

withInput

@NotNull
public @NotNull HttpClient.WrappedRequestBuilder withInput(@NotNull
 @NotNull Supplier<Object> input)

Specify an input supplier which will be used to write to the connection, if it established correctly. This requires that there is a EntityMapper.EntitySerializer registered for the type of the object, in the EntityMapper used by the client

Parameters:

input - Input

Returns:

Builder instance

withMapper

@NotNull
public @NotNull HttpClient.WrappedRequestBuilder withMapper(@NotNull
 @NotNull EntityMapper mapper)

Specify the entity mapper used by the request

Parameters:

mapper - Entity mapper

Returns:

Builder instance

withHeader

@NotNull
public @NotNull HttpClient.WrappedRequestBuilder withHeader(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

Add a header to the request

Parameters:

key - Header key

value - Header value

Returns:

Builder instance

onStatus

@NotNull
public @NotNull HttpClient.WrappedRequestBuilder onStatus(int code,
 @NotNull
 @NotNull Consumer<HttpResponse> responseConsumer)

Add a consumer that acts on a specific status code

Parameters:

code - Status code

responseConsumer - Response consumer

Returns:

Builder instance

onRemaining

@NotNull
public @NotNull HttpClient.WrappedRequestBuilder onRemaining(@NotNull
 @NotNull Consumer<HttpResponse> responseConsumer)

Add a consumer that acts on all remaining status code

Parameters:

responseConsumer - Response consumer

Returns:

Builder instance

onException

@NotNull
public @NotNull HttpClient.WrappedRequestBuilder onException(@NotNull
 @NotNull Consumer<Throwable> consumer)

Add an exception consumer

Parameters:

consumer - Exception consumer

Returns:

Builder instance

execute

@Nullable
public @Nullable HttpResponse execute()

Perform the request

Returns:

The raw response, if no exception was thrown during the handling of the response. If any exception was handled, the method will return null