Package net.webpdf.wsclient.session.connection.http

Class HttpRestRequest

java.lang.Object

net.webpdf.wsclient.session.connection.http.HttpRestRequest

public class HttpRestRequest
extends Object

An instance of HttpRestRequest monitors and executes a webPDF wsclient request executed within a RestSession and handles the server´s response.

Method Summary

Modifier and Type	Method	Description
@NotNull HttpRestRequest	buildRequest(@NotNull HttpMethod httpMethod, @NotNull String path)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).
@NotNull HttpRestRequest	buildRequest(@NotNull HttpMethod httpMethod, @NotNull String path, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).
@NotNull HttpRestRequest	buildRequest(@NotNull HttpMethod httpMethod, @NotNull String path, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @Nullable AuthMaterial authMaterial)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).
@NotNull HttpRestRequest	buildRequest(@NotNull HttpMethod httpMethod, @NotNull URI uri)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).
@NotNull HttpRestRequest	buildRequest(@NotNull HttpMethod httpMethod, @NotNull URI uri, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).
@NotNull HttpRestRequest	buildRequest(@NotNull HttpMethod httpMethod, @NotNull URI uri, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @Nullable AuthMaterial authMaterial)	Prepare the HttpRestRequest to execute the selected HttpMethod on the given (URI) and providing the given HttpEntity as it´s data transfer object (parameters).
static @NotNull HttpRestRequest	createRequest(@NotNull RestSession<?> session)	Creates a HttpRestRequest preparing and executing a request for a given RestSession to provide a matching response object.
org.apache.hc.core5.http.ClassicHttpResponse	executeRequest()	Executes this HttpRestRequest.
void	executeRequest(@NotNull OutputStream outputStream)	Executes this HttpRestRequest and shall write the contained data transfer object HttpEntity to the given OutputStream.
<T> T	executeRequest(@NotNull Class<T> type)	Executes HttpRestRequest and shall attempt to translate the response´s data transfer object (HttpEntity) to an instance of the given type.
@NotNull HttpRestRequest	setAcceptHeader(@NotNull String mimeType)	Selects the MIME type of the data transfer object (HttpEntity) that shall be accepted as a valid response payload for this HttpRestRequest.
@NotNull HttpRestRequest	setAdditionalHeader(String key, String value)	sets an additional HttpHeaders for this HttpRestRequest

Methods inherited from class java.lang.Object

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

Method Detail

createRequest

@NotNull
public static @NotNull HttpRestRequest createRequest(@NotNull
                                                     @NotNull RestSession<?> session)

Creates a HttpRestRequest preparing and executing a request for a given RestSession to provide a matching response object.

Parameters:

session - the RestSession this Rest request is handling.

Returns:

A HttpRestRequest preparing and executing a request for a given RestSession to provide a matching response object.

setAcceptHeader

@NotNull
public @NotNull HttpRestRequest setAcceptHeader(@NotNull
                                                @NotNull String mimeType)

Selects the MIME type of the data transfer object (HttpEntity) that shall be accepted as a valid response payload for this HttpRestRequest.

Parameters:

mimeType - The MIME type of the transfer data object that shall be accepted as a valid response payload for this HttpRestRequest.

Returns:

The HttpRestRequest instance itself.

setAdditionalHeader

@NotNull
public @NotNull HttpRestRequest setAdditionalHeader(String key,
                                                    String value)

sets an additional HttpHeaders for this HttpRestRequest

Parameters:

key - The HttpHeaders to set

value - The value of the header

Returns:

The HttpRestRequest instance itself.

buildRequest

@NotNull
public @NotNull HttpRestRequest buildRequest(@NotNull
                                             @NotNull HttpMethod httpMethod,
                                             @NotNull
                                             @NotNull String path)
                                      throws ResultException

Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).

Parameters:

httpMethod - The HttpMethod to execute.

path - The resource path (URI) to execute the request on.

Returns:

The HttpRestRequest instance itself.

Throws:

ResultException - Shall be thrown, if creating initializing the HttpRestRequest failed for the given parameters.

buildRequest

@NotNull
public @NotNull HttpRestRequest buildRequest(@NotNull
                                             @NotNull HttpMethod httpMethod,
                                             @NotNull
                                             @NotNull String path,
                                             @Nullable
                                             @Nullable org.apache.hc.core5.http.HttpEntity httpEntity)
                                      throws ResultException

Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).

Parameters:

httpMethod - The HttpMethod to execute.

path - The resource path (URI) to execute the request on.

httpEntity - The data transfer object HttpEntity to include in the request´s content.

Returns:

The HttpRestRequest instance itself.

Throws:

ResultException - Shall be thrown, if creating initializing the HttpRestRequest failed for the given parameters.

buildRequest

@NotNull
public @NotNull HttpRestRequest buildRequest(@NotNull
                                             @NotNull HttpMethod httpMethod,
                                             @NotNull
                                             @NotNull String path,
                                             @Nullable
                                             @Nullable org.apache.hc.core5.http.HttpEntity httpEntity,
                                             @Nullable
                                             @Nullable AuthMaterial authMaterial)
                                      throws ResultException

Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).

Parameters:

httpMethod - The HttpMethod to execute.

path - The resource path (URI) to execute the request on.

httpEntity - The data transfer object HttpEntity to include in the request´s content.

authMaterial - The AuthMaterial to use for authorization.

Returns:

The HttpRestRequest instance itself.

Throws:

ResultException - Shall be thrown, if creating initializing the HttpRestRequest failed for the given parameters.

buildRequest

@NotNull
public @NotNull HttpRestRequest buildRequest(@NotNull
                                             @NotNull HttpMethod httpMethod,
                                             @NotNull
                                             @NotNull URI uri,
                                             @Nullable
                                             @Nullable org.apache.hc.core5.http.HttpEntity httpEntity)
                                      throws ResultException

Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).

Parameters:

httpMethod - The HttpMethod to execute.

uri - The resource path (URI) to execute the request on.

httpEntity - The data transfer object HttpEntity to include in the request´s content.

Returns:

The HttpRestRequest instance itself.

Throws:

ResultException - Shall be thrown, if creating initializing the HttpRestRequest failed for the given parameters.

buildRequest

@NotNull
public @NotNull HttpRestRequest buildRequest(@NotNull
                                             @NotNull HttpMethod httpMethod,
                                             @NotNull
                                             @NotNull URI uri)
                                      throws ResultException

Prepare the HttpRestRequest to execute the selected HttpMethod on the given resource path (URI) and providing the given HttpEntity as it´s data transfer object (parameters).

Parameters:

httpMethod - The HttpMethod to execute.

uri - The resource path (URI) to execute the request on.

Returns:

The HttpRestRequest instance itself.

Throws:

ResultException - Shall be thrown, if creating initializing the HttpRestRequest failed for the given parameters.

buildRequest

@NotNull
public @NotNull HttpRestRequest buildRequest(@NotNull
                                             @NotNull HttpMethod httpMethod,
                                             @NotNull
                                             @NotNull URI uri,
                                             @Nullable
                                             @Nullable org.apache.hc.core5.http.HttpEntity httpEntity,
                                             @Nullable
                                             @Nullable AuthMaterial authMaterial)
                                      throws ResultException

Prepare the HttpRestRequest to execute the selected HttpMethod on the given (URI) and providing the given HttpEntity as it´s data transfer object (parameters).

Parameters:

httpMethod - The HttpMethod to execute.

uri - The resource (URI) to execute the request on.

httpEntity - The data transfer object HttpEntity to include in the request´s content.

authMaterial - The AuthMaterial to use for authorization.

Returns:

The HttpRestRequest instance itself.

Throws:

ResultException - Shall be thrown, if creating initializing the HttpRestRequest failed for the given parameters.

executeRequest

public void executeRequest(@NotNull
                           @NotNull OutputStream outputStream)
                    throws ResultException

Executes this HttpRestRequest and shall write the contained data transfer object HttpEntity to the given OutputStream.

Parameters:

outputStream - The OutputStream to write the data transfer object HttpEntity to.

Throws:

ResultException - Shall be thrown, if writing to the OutputStream failed.

executeRequest

public org.apache.hc.core5.http.ClassicHttpResponse executeRequest()
                                                            throws ResultException

Executes this HttpRestRequest.

Returns:

The resulting ClassicHttpResponse.

Throws:

ResultException - Shall be thrown, if writing to the OutputStream failed.

executeRequest

@Nullable
public <T> T executeRequest(@NotNull
                            @NotNull Class<T> type)
                     throws ResultException

Executes HttpRestRequest and shall attempt to translate the response´s data transfer object (HttpEntity) to an instance of the given type.

The resulting intermediate HttpResponse shall be checked via checkResponse(ClassicHttpResponse)}.

Parameters:

type - The type to translate the data transfer object HttpEntity to.

Returns:

The resulting data transfer object HttpEntity translated to an instance of the given type.

Throws:

ResultException - Shall be thrown, should the HttpResponse not be readable or should it´s validation via checkResponse(ClassicHttpResponse) fail.