Package ru.moysklad.remap_1_2.utils

Class HttpRequestExecutor

  • public final class HttpRequestExecutor
extends Object

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      HttpRequestExecutor apiParams​(ApiParam... params)
      Добавить параметр API (например order, filter, offset и т. п.)
      HttpRequestExecutor body​(Object o)
      Добавить тело запроса (для запросов, поддерживающих отправку данных в теле)
      void delete()
      Выполняет DELETE-запрос с указанными ранее параметрами
      String get()
      Выполняет GET-запрос с указанными ранее параметрами
      <T> T get​(Class<T> cl)
      Выполняет GET-запрос с указанными ранее параметрами и конвертирует ответ в объект указанного класса
      HttpRequestExecutor header​(String key, Object value)
      Добавить параметр в заголовки запроса
      <T extends MetaEntity>
      ListEntity<T>      		 list​(Class<T> cl)
      Выполняет GET-запрос с указанными ранее параметрами и конвертирует ответ в массив объектов указанного класса
      static HttpRequestExecutor path​(ApiClient api, String path)
      Создаёт билдер запроса к методу API
      <T extends MetaEntity>
      List<T>      		 plainList​(Class<T> cl)
      Выполняет GET-запрос с указанными ранее параметрами и конвертирует ответ в список объектов указанного класса
      String post()
      Выполняет POST-запрос с указанными ранее параметрами
      <T> T post​(Class<T> cl)
      Выполняет POST-запрос с указанными ранее параметрами и конвертирует ответ в объект указанного класса
      File postAndSaveTo​(File file)
      Выполняет POST-запрос с указанными ранее параметрами и сохраняет ответ в указанный файл
      <T> List<T> postList​(Class<T> cl)
      Выполняет POST-запрос с указанными ранее параметрами и конвертирует ответ в массив объектов указанного класса
      String put()
      Выполняет PUT-запрос с указанными ранее параметрами
      <T> T put​(Class<? extends T> cl)
      Выполняет PUT-запрос с указанными ранее параметрами и конвертирует ответ в объект указанного класса
      HttpRequestExecutor query​(String key, Object value)
      Добавить параметр в строку запроса после URL в формате key=value&.
      static void setQueryParamsCharset​(Charset queryParamsCharset)
      Задаёт кодировку параметров запроса
      static HttpRequestExecutor url​(ApiClient api, String url)
      Создаёт билдер запроса к URL

    • Method Detail

      • setQueryParamsCharset

        public static void setQueryParamsCharset​(Charset queryParamsCharset)
        Задаёт кодировку параметров запроса

      • path

        public static HttpRequestExecutor path​(ApiClient api,
                                       String path)
        Создаёт билдер запроса к методу API
        Parameters:
        api - проинициализированный экземпляр класса с данными API
        path - путь к методу API (например /entity/counterparty/metadata)

      • query

        public HttpRequestExecutor query​(String key,
                                 Object value)
        Добавить параметр в строку запроса после URL в формате key=value&.

      • apiParams

        public HttpRequestExecutor apiParams​(ApiParam... params)
        Добавить параметр API (например order, filter, offset и т. п.)

      • body

        public HttpRequestExecutor body​(Object o)
        Добавить тело запроса (для запросов, поддерживающих отправку данных в теле)

      • get

        public String get()
           throws IOException,
                  ApiClientException
        Выполняет GET-запрос с указанными ранее параметрами
        Returns:
        тело ответа
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • get

        public <T> T get​(Class<T> cl)
          throws IOException,
                 ApiClientException
        Выполняет GET-запрос с указанными ранее параметрами и конвертирует ответ в объект указанного класса
        Parameters:
        cl - класс, в который нужно сконвертировать ответ на запрос
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • list

        public <T extends MetaEntity> ListEntity<T> list​(Class<T> cl)
                                          throws IOException,
                                                 ApiClientException
        Выполняет GET-запрос с указанными ранее параметрами и конвертирует ответ в массив объектов указанного класса
        Parameters:
        cl - класс объектов массива, в который нужно сконвертировать ответ на запрос
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • plainList

        public <T extends MetaEntity> List<T> plainList​(Class<T> cl)
                                         throws IOException,
                                                ApiClientException
        Выполняет GET-запрос с указанными ранее параметрами и конвертирует ответ в список объектов указанного класса
        Parameters:
        cl - класс объектов списка, в который нужно сконвертировать ответ на запрос
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • post

        public String post()
            throws IOException,
                   ApiClientException
        Выполняет POST-запрос с указанными ранее параметрами
        Returns:
        тело ответа
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • postAndSaveTo

        public File postAndSaveTo​(File file)
                   throws IOException,
                          ApiClientException
        Выполняет POST-запрос с указанными ранее параметрами и сохраняет ответ в указанный файл
        Returns:
        тело ответа
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • post

        public <T> T post​(Class<T> cl)
           throws IOException,
                  ApiClientException
        Выполняет POST-запрос с указанными ранее параметрами и конвертирует ответ в объект указанного класса
        Parameters:
        cl - класс, в который нужно сконвертировать ответ на запрос
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • postList

        public <T> List<T> postList​(Class<T> cl)
                     throws IOException,
                            ApiClientException
        Выполняет POST-запрос с указанными ранее параметрами и конвертирует ответ в массив объектов указанного класса
        Parameters:
        cl - класс объектов массива, в который нужно сконвертировать ответ на запрос
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • delete

        public void delete()
            throws IOException,
                   ApiClientException
        Выполняет DELETE-запрос с указанными ранее параметрами
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • put

        public String put()
           throws IOException,
                  ApiClientException
        Выполняет PUT-запрос с указанными ранее параметрами
        Returns:
        тело ответа
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API

      • put

        public <T> T put​(Class<? extends T> cl)
          throws IOException,
                 ApiClientException
        Выполняет PUT-запрос с указанными ранее параметрами и конвертирует ответ в объект указанного класса
        Parameters:
        cl - класс, в который нужно сконвертировать ответ на запрос
        Throws:
        IOException - когда возникла сетевая ошибка
        ApiClientException - когда возникла ошибка API