org.everit.http.restclient

Class RestRequest

java.lang.Object

org.everit.http.restclient.RestRequest

public final class RestRequest
extends Object

A rest request that can be sent to a remote endpoint with one of the CallEndpoint parameters of RestCallUtil.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestRequest.Builder Builder to build RestRequest.

Method Summary

Modifier and Type	Method and Description
static RestRequest.Builder	builder() Creates builder to build RestRequest.
static RestRequest.Builder	builderFrom(RestRequest restRequest) Creates a builder to build RestRequest and initialize it with the given object.
String	buildPathWithPathParams() Builds the path that will be used by this request including the path parameters.
String	buildURI() Builds the full URL that will be used to send this request, including the basePath, the path with the injected path parameters and the query parameters.
String	getBasePath() The base path of the request with probably the protocol, hostname and optionally the port.
Map<String,String>	getHeaders() The headers of the rest request.
org.everit.http.client.HttpMethod	getMethod() Method of the rest request.
String	getPath() Path of the rest request.
Map<String,String>	getPathParams() Path parameters that will be injected within #path(String).
Map<String,Collection<String>>	getQueryParams() Query parameters that will be appended after the path.
Optional<?>	getRequestBody() Optional body of the request.

Methods inherited from class java.lang.Object

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

Method Detail

builder

@Generated(value="SparkTools")
public static RestRequest.Builder builder()

Creates builder to build RestRequest.

Returns:

created builder

builderFrom

@Generated(value="SparkTools")
public static RestRequest.Builder builderFrom(RestRequest restRequest)

Creates a builder to build RestRequest and initialize it with the given object.

Parameters:

restRequest - to initialize the builder with

Returns:

created builder

buildPathWithPathParams

public String buildPathWithPathParams()

Builds the path that will be used by this request including the path parameters.

buildURI

public String buildURI()

Builds the full URL that will be used to send this request, including the basePath, the path with the injected path parameters and the query parameters.

getBasePath

public String getBasePath()

The base path of the request with probably the protocol, hostname and optionally the port.

getHeaders

public Map<String,String> getHeaders()

The headers of the rest request.

getMethod

public org.everit.http.client.HttpMethod getMethod()

Method of the rest request. Default: HttpMethod.GET

getPath

public String getPath()

Path of the rest request.

getPathParams

public Map<String,String> getPathParams()

Path parameters that will be injected within #path(String).

getQueryParams

public Map<String,Collection<String>> getQueryParams()

Query parameters that will be appended after the path.

getRequestBody

public Optional<?> getRequestBody()

Optional body of the request. If the object is an implementation of AsyncContentProvider it is be used as is, otherwise Jackson is used to convert the object to a JSON String.