com.crowdin.client.core.http

Interface HttpClient

All Known Implementing Classes:

ApacheHttpClient

public interface HttpClient

Http client interface for library. Default implementation ApacheHttpClient uses apache http library Develop own implementation if you need to use different http client and pass it to ClientConfig See post(java.lang.String, V, com.crowdin.client.core.http.HttpRequestConfig, java.lang.Class<T>) for documentation

Method Summary

Modifier and Type	Method and Description
default java.lang.String	appendUrlParams(java.lang.String url, java.util.Map<java.lang.String,? extends java.util.Optional> urlParams)
<T> T	delete(java.lang.String url, HttpRequestConfig config, java.lang.Class<T> clazz)
<T> T	get(java.lang.String url, HttpRequestConfig config, java.lang.Class<T> clazz)
<T> T	head(java.lang.String url, HttpRequestConfig config, java.lang.Class<T> clazz)
<T,V> T	patch(java.lang.String url, V data, HttpRequestConfig config, java.lang.Class<T> clazz)
<T,V> T	post(java.lang.String url, V data, HttpRequestConfig config, java.lang.Class<T> clazz)
<T,V> T	put(java.lang.String url, V data, HttpRequestConfig config, java.lang.Class<T> clazz)

Method Detail

get

<T> T get(java.lang.String url,
          HttpRequestConfig config,
          java.lang.Class<T> clazz)
   throws HttpException,
          HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

delete

<T> T delete(java.lang.String url,
             HttpRequestConfig config,
             java.lang.Class<T> clazz)
      throws HttpException,
             HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

head

<T> T head(java.lang.String url,
           HttpRequestConfig config,
           java.lang.Class<T> clazz)
    throws HttpException,
           HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

post

<T,V> T post(java.lang.String url,
             V data,
             HttpRequestConfig config,
             java.lang.Class<T> clazz)
      throws HttpException,
             HttpBadRequestException

Type Parameters:

T - return type

V - request data type

Parameters:

url - base url (with or without query parameters)

data - request data (can be InputStream or String or any other java class which will be converted into json string)

config - http config with query parameters (no need to include them if they are already in url), headers (without Authorization)

clazz - return class type (internally http client will work with java classes without generic type, like ProjectBuildResponseList)

Returns:

http response object

Throws:

HttpException - in case of any error (except validation)

HttpBadRequestException - in case of validation errors

put

<T,V> T put(java.lang.String url,
            V data,
            HttpRequestConfig config,
            java.lang.Class<T> clazz)
     throws HttpException,
            HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

patch

<T,V> T patch(java.lang.String url,
              V data,
              HttpRequestConfig config,
              java.lang.Class<T> clazz)
       throws HttpException,
              HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

appendUrlParams

default java.lang.String appendUrlParams(java.lang.String url,
                                         java.util.Map<java.lang.String,? extends java.util.Optional> urlParams)