Class RestServiceClientHelper
-
- All Implemented Interfaces:
public class RestServiceClientHelper
Класс, от которого наследуются тестовые клиенты к rest-сервисам. Предоставляет методы, с помощью которых можно отправлять запросы к сервисам.
Примеры:
public class RestClient extends RestServiceClientHelper { public RestClient(String host) { super(host); } public RestResponse<Response> getMethod() { return sendGetRequest(Response.class, "v2/api/get/method"); } }
public class RestClient extends RestServiceClientHelper { public RestClient(String host) { super(host, new BasicHeader("headerName", "value")); } public RestResponse<Response> postMethod(Request request) { return sendPostRequest(Response.class, "v2/api/post/method", request); } public RestResponse<Response> getMethod() { return sendGetRequest(Response.class, "v2/api/get/method"); } }
public class RestClient extends RestServiceClientHelper { public RestClient(String host) { super(host, new BasicHeader("headerName1", "value1"), new BasicHeader("headerName2", "value2")); } public RestResponse<Response> postMethod(Request request, Boolean needThrow) throws RestException { return sendPostRequest(needThrow, Response.class, "v2/api/post/method", request); } }
-
-
Constructor Summary
Constructors Constructor Description RestServiceClientHelper(String host, NameValuePair defaultHeaders)
Конструктор класса RestServiceClientHelper(String host, Function1<HttpClientBuilder, HttpClientBuilder> httpClientBuilderFunc, NameValuePair defaultHeaders)
Конструктор класса. RestServiceClientHelper(String host, Boolean trustAllCertificates, NameValuePair defaultHeaders)
Конструктор класса
-
Method Summary
Modifier and Type Method Description final Unit
close()
Метод закрывает http-клиент, если он был создан в процессе выполнения теста. final RestServiceClientHelper
turnOffLoggingRequestString()
Выключение логирования содержимого запроса к методам типа POST, PUT, PATCH. final RestServiceClientHelper
setUseStdBeanNamingForSerialization(Boolean useStdBeanNaming)
Использование настройки MapperFeature.USE_STD_BEAN_NAMING для сериализации final RestServiceClientHelper
setTrustAllCertificates(Boolean trust)
Использование настройки trustAllCertificates final RestServiceClientHelper
setSerializeJsonMapper(JsonMapper mapper)
Использование своего JsonMapper (вместо стандартного) для сереализации объектов final RestServiceClientHelper
setDeserializeJsonMapper(JsonMapper mapper)
Использование своего JsonMapper (вместо стандартного) для десереализации Json final RestResponse<?>
sendDeleteRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса delete и получение ответа в виде строки final RestResponse<?>
sendDeleteRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса delete и получение ответа в виде строки final RestResponse<?>
sendDeleteRequest(String method)
Отправка запроса delete и получение ответа в виде строки final <T extends Any> RestResponse<T>
sendDeleteRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса delete и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendDeleteRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса delete и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendDeleteRequest(Class<T> responseClass, String method)
Отправка запроса delete и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendDeleteRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса delete и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendDeleteRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса delete и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendDeleteRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса delete и получение ответа в виде объекта. final RestResponse<?>
sendGetRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса get и получение ответа в виде строки final RestResponse<?>
sendGetRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса get и получение ответа в виде строки final RestResponse<?>
sendGetRequest(String method)
Отправка запроса get и получение ответа в виде строки final <T extends Any> RestResponse<T>
sendGetRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса get и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendGetRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса get и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendGetRequest(Class<T> responseClass, String method)
Отправка запроса get и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendGetRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса get и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendGetRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса get и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendGetRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса get и получение ответа в виде объекта. final RestResponse<?>
sendHeadRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса head final RestResponse<?>
sendHeadRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса head final RestResponse<?>
sendHeadRequest(String method)
Отправка запроса head final RestResponse<?>
sendTraceRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса trace final RestResponse<?>
sendTraceRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса trace final RestResponse<?>
sendTraceRequest(String method)
Отправка запроса trace final RestResponse<?>
sendOptionsRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса options final RestResponse<?>
sendOptionsRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса options final RestResponse<?>
sendOptionsRequest(String method)
Отправка запроса options final RestResponse<?>
sendPatchRequest(String method, Object request, List<NameValuePair> headers)
Отправка запроса patch final RestResponse<?>
sendPatchRequest(String method, Object request)
Отправка запроса patch final RestResponse<?>
sendPatchRequest(String method)
Отправка запроса patch final <T extends Any> RestResponse<T>
sendPatchRequest(Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса patch и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendPatchRequest(Class<T> responseClass, String method, Object request)
Отправка запроса patch и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendPatchRequest(Class<T> responseClass, String method)
Отправка запроса patch и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendPatchRequest(Boolean needThrow, Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса patch и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendPatchRequest(Boolean needThrow, Class<T> responseClass, String method, Object request)
Отправка запроса patch и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendPatchRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса patch и получение ответа в виде объекта. final RestResponse<?>
sendPostRequest(String method, Object request, List<NameValuePair> headers)
Отправка запроса post final RestResponse<?>
sendPostRequest(String method, Object request)
Отправка запроса post final RestResponse<?>
sendPostRequest(String method)
Отправка запроса post final <T extends Any> RestResponse<T>
sendPostRequest(Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса post и получение ответа в виде объекта RestResponse final <T extends Any> RestResponse<T>
sendPostRequest(Class<T> responseClass, String method, Object request)
Отправка запроса post и получение ответа в виде объекта RestResponse final <T extends Any> RestResponse<T>
sendPostRequest(Class<T> responseClass, String method)
Отправка запроса post и получение ответа в виде объекта RestResponse final <T extends Any> RestResponse<T>
sendPostRequest(Boolean needThrow, Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса post и получение ответа в виде объекта RestResponse. final <T extends Any> RestResponse<T>
sendPostRequest(Boolean needThrow, Class<T> responseClass, String method, Object request)
Отправка запроса post и получение ответа в виде объекта RestResponse. final <T extends Any> RestResponse<T>
sendPostRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса post и получение ответа в виде объекта RestResponse. final RestResponse<?>
sendPostRequestWithMultipart(String method, List<NameValuePair> formData, List<NameValuePair> headers, File file)
Отправка запроса post с составным типом содержимого final RestResponse<?>
sendPostRequestWithMultipart(String method, List<NameValuePair> formData, List<NameValuePair> headers)
Отправка запроса post с составным типом содержимого final RestResponse<?>
sendPostRequestWithMultipart(String method, List<NameValuePair> formData)
Отправка запроса post с составным типом содержимого final RestResponse<?>
sendPostRequestWithMultipart(String method)
Отправка запроса post с составным типом содержимого final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers, File file)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Class<T> responseClass, String method, List<NameValuePair> formData)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Class<T> responseClass, String method)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers, File file)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> formData)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. final <T extends Any> RestResponse<T>
sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. final RestResponse<?>
sendPostRequestWithFormUrlencoded(String method, List<NameValuePair> data, List<NameValuePair> headers)
Отправка запроса post с типом form urlencoded final RestResponse<?>
sendPostRequestWithFormUrlencoded(String method, List<NameValuePair> data)
Отправка запроса post с типом form urlencoded final RestResponse<String>
sendPutRequest(String method, Object request, List<NameValuePair> headers)
Отправка запроса put и получение ответа в виде строки final RestResponse<String>
sendPutRequest(String method, Object request)
Отправка запроса put и получение ответа в виде строки final RestResponse<String>
sendPutRequest(String method)
Отправка запроса put и получение ответа в виде строки final <T extends Any> RestResponse<T>
sendPutRequest(Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса put и получение ответа в виде объекта RestResponse final <T extends Any> RestResponse<T>
sendPutRequest(Class<T> responseClass, String method, Object request)
Отправка запроса put и получение ответа в виде объекта RestResponse final <T extends Any> RestResponse<T>
sendPutRequest(Class<T> responseClass, String method)
Отправка запроса put и получение ответа в виде объекта RestResponse final <T extends Any> RestResponse<T>
sendPutRequest(Boolean needThrow, Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса put и получение ответа в виде объекта RestResponse. final <T extends Any> RestResponse<T>
sendPutRequest(Boolean needThrow, Class<T> responseClass, String method, Object request)
Отправка запроса put и получение ответа в виде объекта RestResponse. final <T extends Any> RestResponse<T>
sendPutRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса put и получение ответа в виде объекта RestResponse. final RestResponse<?>
sendCustomRequest(String method, BasicClassicHttpRequest request)
Отправка пользовательского запроса. final <T extends Any> RestResponse<T>
sendCustomRequest(Class<T> responseClass, String method, BasicClassicHttpRequest request)
Отправка пользовательского запроса. final <T extends Any> RestResponse<T>
sendCustomRequest(Boolean needThrow, Class<T> responseClass, String method, BasicClassicHttpRequest request)
Отправка пользовательского запроса. final BasicHeader
createContentDispositionHeader(File file, Charset charset, String locale)
Создание заголовка "Content-Disposition". final BasicHeader
createContentDispositionHeader(File file, Charset charset)
Создание заголовка "Content-Disposition". final BasicHeader
createContentDispositionHeader(File file)
Создание заголовка "Content-Disposition". -
-
Constructor Detail
-
RestServiceClientHelper
RestServiceClientHelper(String host, NameValuePair defaultHeaders)
Конструктор класса
-
RestServiceClientHelper
RestServiceClientHelper(String host, Function1<HttpClientBuilder, HttpClientBuilder> httpClientBuilderFunc, NameValuePair defaultHeaders)
Конструктор класса.
-
-
Method Detail
-
close
final Unit close()
Метод закрывает http-клиент, если он был создан в процессе выполнения теста.
Вызывается в методе с аннотацией org.junit.jupiter.api.AfterEach перед вызовом BaseHelper.stop
- Since:
2.5.0
-
turnOffLoggingRequestString
final RestServiceClientHelper turnOffLoggingRequestString()
Выключение логирования содержимого запроса к методам типа POST, PUT, PATCH.
Метод используется в том случае, если в запрос к сервису передается слишком большое количество информации и построение сообщения для логирования вызывает ошибку OutOfMemory.
Вызывается в конструкторе хелпера, унаследованного от RestServiceClientHelper
- Returns:
- Since:
2.4.1
-
setUseStdBeanNamingForSerialization
final RestServiceClientHelper setUseStdBeanNamingForSerialization(Boolean useStdBeanNaming)
Использование настройки MapperFeature.USE_STD_BEAN_NAMING для сериализации
- Parameters:
useStdBeanNaming
- Использование настройки MapperFeature.USE_STD_BEAN_NAMING
-
setTrustAllCertificates
final RestServiceClientHelper setTrustAllCertificates(Boolean trust)
Использование настройки trustAllCertificates
- Parameters:
trust
- Нужно ли доверять всем (в т.ч.- Since:
2.1.3
-
setSerializeJsonMapper
final RestServiceClientHelper setSerializeJsonMapper(JsonMapper mapper)
Использование своего JsonMapper (вместо стандартного) для сереализации объектов
- Parameters:
mapper
- JsonMapper- Since:
2.3.1
-
setDeserializeJsonMapper
final RestServiceClientHelper setDeserializeJsonMapper(JsonMapper mapper)
Использование своего JsonMapper (вместо стандартного) для десереализации Json
- Parameters:
mapper
- JsonMapper- Since:
2.3.1
-
sendDeleteRequest
final RestResponse<?> sendDeleteRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса delete и получение ответа в виде строки
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendDeleteRequest
final RestResponse<?> sendDeleteRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса delete и получение ответа в виде строки
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendDeleteRequest
final RestResponse<?> sendDeleteRequest(String method)
Отправка запроса delete и получение ответа в виде строки
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendDeleteRequest
final <T extends Any> RestResponse<T> sendDeleteRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса delete и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.6
-
sendDeleteRequest
final <T extends Any> RestResponse<T> sendDeleteRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса delete и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.6
-
sendDeleteRequest
final <T extends Any> RestResponse<T> sendDeleteRequest(Class<T> responseClass, String method)
Отправка запроса delete и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.6
-
sendDeleteRequest
final <T extends Any> RestResponse<T> sendDeleteRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса delete и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.6
-
sendDeleteRequest
final <T extends Any> RestResponse<T> sendDeleteRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса delete и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.6
-
sendDeleteRequest
final <T extends Any> RestResponse<T> sendDeleteRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса delete и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.6
-
sendGetRequest
final RestResponse<?> sendGetRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса get и получение ответа в виде строки
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendGetRequest
final RestResponse<?> sendGetRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса get и получение ответа в виде строки
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendGetRequest
final RestResponse<?> sendGetRequest(String method)
Отправка запроса get и получение ответа в виде строки
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendGetRequest
final <T extends Any> RestResponse<T> sendGetRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса get и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendGetRequest
final <T extends Any> RestResponse<T> sendGetRequest(Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса get и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendGetRequest
final <T extends Any> RestResponse<T> sendGetRequest(Class<T> responseClass, String method)
Отправка запроса get и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendGetRequest
final <T extends Any> RestResponse<T> sendGetRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса get и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendGetRequest
final <T extends Any> RestResponse<T> sendGetRequest(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> queryParameters)
Отправка запроса get и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendGetRequest
final <T extends Any> RestResponse<T> sendGetRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса get и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendHeadRequest
final RestResponse<?> sendHeadRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса head
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendHeadRequest
final RestResponse<?> sendHeadRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса head
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendHeadRequest
final RestResponse<?> sendHeadRequest(String method)
Отправка запроса head
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendTraceRequest
final RestResponse<?> sendTraceRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса trace
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendTraceRequest
final RestResponse<?> sendTraceRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса trace
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendTraceRequest
final RestResponse<?> sendTraceRequest(String method)
Отправка запроса trace
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendOptionsRequest
final RestResponse<?> sendOptionsRequest(String method, List<NameValuePair> queryParameters, List<NameValuePair> headers)
Отправка запроса options
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendOptionsRequest
final RestResponse<?> sendOptionsRequest(String method, List<NameValuePair> queryParameters)
Отправка запроса options
- Parameters:
method
- Метод сервисаqueryParameters
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendOptionsRequest
final RestResponse<?> sendOptionsRequest(String method)
Отправка запроса options
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPatchRequest
final RestResponse<?> sendPatchRequest(String method, Object request, List<NameValuePair> headers)
Отправка запроса patch
- Parameters:
method
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final RestResponse<?> sendPatchRequest(String method, Object request)
Отправка запроса patch
- Parameters:
method
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final RestResponse<?> sendPatchRequest(String method)
Отправка запроса patch
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final <T extends Any> RestResponse<T> sendPatchRequest(Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса patch и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final <T extends Any> RestResponse<T> sendPatchRequest(Class<T> responseClass, String method, Object request)
Отправка запроса patch и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final <T extends Any> RestResponse<T> sendPatchRequest(Class<T> responseClass, String method)
Отправка запроса patch и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final <T extends Any> RestResponse<T> sendPatchRequest(Boolean needThrow, Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса patch и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final <T extends Any> RestResponse<T> sendPatchRequest(Boolean needThrow, Class<T> responseClass, String method, Object request)
Отправка запроса patch и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPatchRequest
final <T extends Any> RestResponse<T> sendPatchRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса patch и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequest
final RestResponse<?> sendPostRequest(String method, Object request, List<NameValuePair> headers)
Отправка запроса post
- Parameters:
method
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final RestResponse<?> sendPostRequest(String method, Object request)
Отправка запроса post
- Parameters:
method
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final RestResponse<?> sendPostRequest(String method)
Отправка запроса post
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final <T extends Any> RestResponse<T> sendPostRequest(Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса post и получение ответа в виде объекта RestResponse
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final <T extends Any> RestResponse<T> sendPostRequest(Class<T> responseClass, String method, Object request)
Отправка запроса post и получение ответа в виде объекта RestResponse
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final <T extends Any> RestResponse<T> sendPostRequest(Class<T> responseClass, String method)
Отправка запроса post и получение ответа в виде объекта RestResponse
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final <T extends Any> RestResponse<T> sendPostRequest(Boolean needThrow, Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса post и получение ответа в виде объекта RestResponse. При передаче не null в responseClass и true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final <T extends Any> RestResponse<T> sendPostRequest(Boolean needThrow, Class<T> responseClass, String method, Object request)
Отправка запроса post и получение ответа в виде объекта RestResponse. При передаче не null в responseClass и true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequest
final <T extends Any> RestResponse<T> sendPostRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса post и получение ответа в виде объекта RestResponse. При передаче не null в responseClass и true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
-
sendPostRequestWithMultipart
final RestResponse<?> sendPostRequestWithMultipart(String method, List<NameValuePair> formData, List<NameValuePair> headers, File file)
Отправка запроса post с составным типом содержимого
- Parameters:
method
- Метод сервисаformData
- По умолчанию null.headers
- По умолчанию null.file
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final RestResponse<?> sendPostRequestWithMultipart(String method, List<NameValuePair> formData, List<NameValuePair> headers)
Отправка запроса post с составным типом содержимого
- Parameters:
method
- Метод сервисаformData
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final RestResponse<?> sendPostRequestWithMultipart(String method, List<NameValuePair> formData)
Отправка запроса post с составным типом содержимого
- Parameters:
method
- Метод сервисаformData
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final RestResponse<?> sendPostRequestWithMultipart(String method)
Отправка запроса post с составным типом содержимого
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers, File file)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаformData
- По умолчанию null.headers
- По умолчанию null.file
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаformData
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Class<T> responseClass, String method, List<NameValuePair> formData)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаformData
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Class<T> responseClass, String method)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers, File file)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаformData
- По умолчанию null.headers
- По умолчанию null.file
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> formData, List<NameValuePair> headers)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаformData
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method, List<NameValuePair> formData)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаformData
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithMultipart
final <T extends Any> RestResponse<T> sendPostRequestWithMultipart(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса post c составным типом содержимого и получение ответа в виде объекта. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPostRequestWithFormUrlencoded
final RestResponse<?> sendPostRequestWithFormUrlencoded(String method, List<NameValuePair> data, List<NameValuePair> headers)
Отправка запроса post с типом form urlencoded
- Parameters:
method
- Метод сервисаdata
- Список элементов form urlencoded (список объектов BasicNameValuePair)headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
- Since:
2.1.4
-
sendPostRequestWithFormUrlencoded
final RestResponse<?> sendPostRequestWithFormUrlencoded(String method, List<NameValuePair> data)
Отправка запроса post с типом form urlencoded
- Parameters:
method
- Метод сервисаdata
- Список элементов form urlencoded (список объектов BasicNameValuePair)- Returns:
Ответ от сервиса в виде объекта RestResponse
- Since:
2.1.4
-
sendPutRequest
final RestResponse<String> sendPutRequest(String method, Object request, List<NameValuePair> headers)
Отправка запроса put и получение ответа в виде строки
- Parameters:
method
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPutRequest
final RestResponse<String> sendPutRequest(String method, Object request)
Отправка запроса put и получение ответа в виде строки
- Parameters:
method
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPutRequest
final RestResponse<String> sendPutRequest(String method)
Отправка запроса put и получение ответа в виде строки
- Parameters:
method
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта RestResponse
-
sendPutRequest
final <T extends Any> RestResponse<T> sendPutRequest(Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса put и получение ответа в виде объекта RestResponse
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.7
-
sendPutRequest
final <T extends Any> RestResponse<T> sendPutRequest(Class<T> responseClass, String method, Object request)
Отправка запроса put и получение ответа в виде объекта RestResponse
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.7
-
sendPutRequest
final <T extends Any> RestResponse<T> sendPutRequest(Class<T> responseClass, String method)
Отправка запроса put и получение ответа в виде объекта RestResponse
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.7
-
sendPutRequest
final <T extends Any> RestResponse<T> sendPutRequest(Boolean needThrow, Class<T> responseClass, String method, Object request, List<NameValuePair> headers)
Отправка запроса put и получение ответа в виде объекта RestResponse. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.headers
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.7
-
sendPutRequest
final <T extends Any> RestResponse<T> sendPutRequest(Boolean needThrow, Class<T> responseClass, String method, Object request)
Отправка запроса put и получение ответа в виде объекта RestResponse. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаrequest
- По умолчанию null.- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.7
-
sendPutRequest
final <T extends Any> RestResponse<T> sendPutRequest(Boolean needThrow, Class<T> responseClass, String method)
Отправка запроса put и получение ответа в виде объекта RestResponse. При передаче true в параметр needThrow и возникновении ошибки выбрасывается исключение RestException. Метод используется для негативных проверок
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервиса- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.0.7
-
sendCustomRequest
final RestResponse<?> sendCustomRequest(String method, BasicClassicHttpRequest request)
Отправка пользовательского запроса.
В поле RestResponse.httpResponseEntityContent добавляется пустой массив байтов, т.к. InputStream (поле CloseableHttpResponse.Entity.Content) остаётся непрочитанным.
- Parameters:
method
- Метод сервисаrequest
- Объект HttpRequestBase, содержащий запрос к сервису- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.1.4
-
sendCustomRequest
final <T extends Any> RestResponse<T> sendCustomRequest(Class<T> responseClass, String method, BasicClassicHttpRequest request)
Отправка пользовательского запроса.
- Parameters:
responseClass
- Класс ответаmethod
- Метод сервисаrequest
- Объект HttpRequestBase, содержащий запрос к сервису- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.4.0
-
sendCustomRequest
final <T extends Any> RestResponse<T> sendCustomRequest(Boolean needThrow, Class<T> responseClass, String method, BasicClassicHttpRequest request)
Отправка пользовательского запроса.
- Parameters:
needThrow
- Нужно ли выбрасывать исключение при возникновении ошибкиresponseClass
- Класс ответаmethod
- Метод сервисаrequest
- Объект HttpRequestBase, содержащий запрос к сервису- Returns:
Ответ от сервиса в виде объекта класса RestResponse
- Since:
2.4.0
-
createContentDispositionHeader
final BasicHeader createContentDispositionHeader(File file, Charset charset, String locale)
Создание заголовка "Content-Disposition".
В заголовке задается "filename" в формате "кодировка'локаль'имя_файла_urlencoded".
- Parameters:
file
- Файл для отправкиcharset
- По умолчанию "UTF-8".locale
- По умолчанию пустая строка.- Returns:
Заголовок BasicHeader
- Since:
2.0.9
-
createContentDispositionHeader
final BasicHeader createContentDispositionHeader(File file, Charset charset)
Создание заголовка "Content-Disposition".
В заголовке задается "filename" в формате "кодировка'локаль'имя_файла_urlencoded".
- Parameters:
file
- Файл для отправкиcharset
- По умолчанию "UTF-8".- Returns:
Заголовок BasicHeader
- Since:
2.0.9
-
createContentDispositionHeader
final BasicHeader createContentDispositionHeader(File file)
Создание заголовка "Content-Disposition".
В заголовке задается "filename" в формате "кодировка'локаль'имя_файла_urlencoded".
- Parameters:
file
- Файл для отправки- Returns:
Заголовок BasicHeader
- Since:
2.0.9
-
-
-
-