net.webpdf.wsclient.http

Class HttpRestRequest

java.lang.Object

net.webpdf.wsclient.http.HttpRestRequest

public class HttpRestRequest
extends Object

Method Summary

Modifier and Type	Method and Description
@NotNull HttpRestRequest	buildRequest(@Nullable HttpMethod httpMethod, @Nullable String path, @Nullable org.apache.http.HttpEntity httpEntity) Build a HTTP request
@NotNull HttpRestRequest	buildRequest(@Nullable HttpMethod httpMethod, @Nullable URI uri, @Nullable org.apache.http.HttpEntity httpEntity) Build a HTTP request
static @NotNull HttpRestRequest	createRequest(@NotNull RestSession session) Creates a Rest request handling the messages of the given RestSession
<T> T	executeRequest(@Nullable Class<T> type) Executes the HTTP request
void	executeRequest(@Nullable OutputStream outputStream) Executes the HTTP request
@NotNull HttpRestRequest	setAcceptHeader(@NotNull String mimeType) Initializes the MIME type accepted by this REST request and returns a reference to this request.

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 Rest request handling the messages of the given RestSession

Parameters:

session - the RestSession this Rest request is handling.

Returns:

A Rest request handling the messages of the given RestSession

setAcceptHeader

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

Initializes the MIME type accepted by this REST request and returns a reference to this request.

Parameters:

mimeType - The MIME type accepted by this REST request.

Returns:

A reference to this REST request.

buildRequest

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

Build a HTTP request

Parameters:

httpMethod - HTTP method (GET, POST, ...)

path - REST resource URL

httpEntity - data to send with request (POST)

Returns:

a new HTTP request

Throws:

ResultException - if the HTTP method is unknown

buildRequest

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

Build a HTTP request

Parameters:

httpMethod - HTTP method (GET, POST, ...)

uri - REST resource URL

httpEntity - data to send with request (POST)

Returns:

a new HTTP request

Throws:

ResultException - if the HTTP method is unknown

executeRequest

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

Executes the HTTP request

Parameters:

outputStream - Target stream for the response

Throws:

ResultException - a ResultException

executeRequest

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

Executes the HTTP request

Type Parameters:

T - class for response

Parameters:

type - class name for response

Returns:

response object

Throws:

ResultException - if HTTP entity should be save as file