B C E F G H J M O P Q R T

B

basePath(String) - Method in class org.everit.http.restclient.RestRequest.Builder

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

build() - Method in class org.everit.http.restclient.RestRequest.Builder

Builds the unmodifiable rest request instance.

builder() - Static method in class org.everit.http.restclient.RestRequest

Creates builder to build RestRequest.

builderFrom(RestRequest) - Static method in class org.everit.http.restclient.RestRequest

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

buildPathWithPathParams() - Method in class org.everit.http.restclient.RestRequest

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

buildURI() - Method in class org.everit.http.restclient.RestRequest

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.

C

callEndpoint(RestRequest, Optional<RestRequestEnhancer>) - Method in class org.everit.http.restclient.RestClient

Calls a rest endpoint asynchronously where there is no response body.

callEndpoint(RestRequest, Optional<RestRequestEnhancer>, TypeReference<T>) - Method in class org.everit.http.restclient.RestClient

Calls a rest endpoint asynchronously.

close() - Method in class org.everit.http.restclient.RestClient

convertValue(Object, Class<T>) - Method in interface org.everit.http.restclient.JSONObjectMapper

Converts a value from an object to another type.

convertValue(Object, TypeReference<T>) - Method in interface org.everit.http.restclient.JSONObjectMapper

Converts a value from an object to another type.

E

enhanceRestRequest(RestRequest) - Method in interface org.everit.http.restclient.RestRequestEnhancer

Enhances the rest request by creating a new instance.

F

fromJSON(String, Class<T>) - Method in interface org.everit.http.restclient.JSONObjectMapper

Converts a JSON string to a type.

fromJSON(String, TypeReference<T>) - Method in interface org.everit.http.restclient.JSONObjectMapper

Converts a JSON string to a type.

G

getBasePath() - Method in class org.everit.http.restclient.RestRequest

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

getHeaders() - Method in class org.everit.http.restclient.RestRequest

The headers of the rest request.

getHttpCode() - Method in exception org.everit.http.restclient.RestException

getMethod() - Method in class org.everit.http.restclient.RestRequest

Method of the rest request.

getObjectMapper() - Method in class org.everit.http.restclient.RestClient

getPath() - Method in class org.everit.http.restclient.RestRequest

Path of the rest request.

getPathParams() - Method in class org.everit.http.restclient.RestRequest

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

getQueryParams() - Method in class org.everit.http.restclient.RestRequest

Query parameters that will be appended after the path.

getRequestBody() - Method in class org.everit.http.restclient.RestRequest

Optional body of the request.

getResponseBody() - Method in exception org.everit.http.restclient.RestException

getType() - Method in class org.everit.http.restclient.TypeReference

H

headers(Map<String, String>) - Method in class org.everit.http.restclient.RestRequest.Builder

The headers of the rest request.

J

JSONObjectMapper - Interface in org.everit.http.restclient

Libraries that use REST Client should provide a JSONObjectMapper that tells the REST client how to convert from String to JSON and vice versa.

M

method(HttpMethod) - Method in class org.everit.http.restclient.RestRequest.Builder

Method of the rest request.

O

objectCollectionToStringCollection(Collection<?>) - Static method in class org.everit.http.restclient.RestClientUtil

Converts any kind of collection to a string collection.

org.everit.http.restclient - package org.everit.http.restclient

P

path(String) - Method in class org.everit.http.restclient.RestRequest.Builder

Path of the rest request.

pathParams(Map<String, String>) - Method in class org.everit.http.restclient.RestRequest.Builder

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

Q

queryParams(Map<String, Collection<String>>) - Method in class org.everit.http.restclient.RestRequest.Builder

Query parameters that will be appended after the path.

R

requestBody(Optional<?>) - Method in class org.everit.http.restclient.RestRequest.Builder

Optional body of the request.

RestClient - Class in org.everit.http.restclient

Calls REST endpoints.

RestClient(HttpClient, JSONObjectMapper) - Constructor for class org.everit.http.restclient.RestClient

RestClientUtil - Class in org.everit.http.restclient

Helper functions to build a RestRequest and do a call.

RestException - Exception in org.everit.http.restclient

Exception type that is thrown if there is a HTTP exception during the REST call.

RestException(String, int, Optional<String>) - Constructor for exception org.everit.http.restclient.RestException

Constructor.

RestException(String, String, int, Optional<String>) - Constructor for exception org.everit.http.restclient.RestException

Constructor.

RestRequest - Class in org.everit.http.restclient

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

RestRequest.Builder - Class in org.everit.http.restclient

Builder to build RestRequest.

RestRequestEnhancer - Interface in org.everit.http.restclient

Programmers can pass an optional RestRequestEnhancer to any of the callEndpoint functions of RestClient that will modify the original request by creating a new one.

T

toJSON(Object) - Method in interface org.everit.http.restclient.JSONObjectMapper

Converts an object to JSON.

type - Variable in class org.everit.http.restclient.TypeReference

TypeReference<T> - Class in org.everit.http.restclient

Helper class to convert JSON to parameterized types by using fromJSON(String, TypeReference).

TypeReference() - Constructor for class org.everit.http.restclient.TypeReference

Constructor.

B C E F G H J M O P Q R T