Package software.xdev.sessionize.client

Class ApiClient

java.lang.Object
software.xdev.sessionize.client.JavaTimeFormatter
software.xdev.sessionize.client.ApiClient
public class ApiClient extends JavaTimeFormatter

  • Field Details

  • Constructor Details

    • ApiClient

      public ApiClient(org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient)

    • ApiClient

      public ApiClient()

  • Method Details

    • buildDefaultDateFormat

      public static DateFormat buildDefaultDateFormat()

    • getObjectMapper

      public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
      Returns the current object mapper used for JSON serialization/deserialization.

      Note: If you make changes to the object mapper, remember to set it back via setObjectMapper in order to trigger HTTP client rebuilding.

      Returns:
      Object mapper

    • setObjectMapper

      public ApiClient setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
      Sets the object mapper.
      Parameters:
      objectMapper - object mapper
      Returns:
      API client

    • getHttpClient

      public org.apache.hc.client5.http.impl.classic.CloseableHttpClient getHttpClient()

    • setHttpClient

      public ApiClient setHttpClient(org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient)
      Sets the HTTP client.
      Parameters:
      httpClient - HTTP client
      Returns:
      API client

    • getBasePath

      public String getBasePath()

    • setBasePath

      public ApiClient setBasePath(String basePath)
      Sets the base path.
      Parameters:
      basePath - base path
      Returns:
      API client

    • getServers

      public List<ServerConfiguration> getServers()

    • setServers

      public ApiClient setServers(List<ServerConfiguration> servers)
      Sets the server.
      Parameters:
      servers - a list of server configuration
      Returns:
      API client

    • getServerIndex

      public Integer getServerIndex()

    • setServerIndex

      public ApiClient setServerIndex(Integer serverIndex)
      Sets the server index.
      Parameters:
      serverIndex - server index
      Returns:
      API client

    • getServerVariables

      public Map<String,String> getServerVariables()

    • setServerVariables

      public ApiClient setServerVariables(Map<String,String> serverVariables)
      Sets the server variables.
      Parameters:
      serverVariables - server variables
      Returns:
      API client

    • getStatusCode

      public int getStatusCode()
      Gets the status code of the previous request
      Returns:
      Status code

    • getResponseHeaders

      public Map<String,List<String>> getResponseHeaders()
      Gets the response headers of the previous request
      Returns:
      Response headers

    • getAuthentications

      public Map<String,Authentication> getAuthentications()
      Get authentications (key: authentication name, value: authentication).
      Returns:
      Map of authentication

    • getAuthentication

      public Authentication getAuthentication(String authName)
      Get authentication for the given name.
      Parameters:
      authName - The authentication name
      Returns:
      The authentication, null if not found

    • getTempFolderPath

      public String getTempFolderPath()
      The path of temporary folder used to store downloaded files from endpoints with file response. The default value is null, i.e. using the system's default temporary folder.
      Returns:
      Temp folder path

    • setUserAgent

      public ApiClient setUserAgent(String userAgent)
      Set the User-Agent header's value (by adding to the default header map).
      Parameters:
      userAgent - User agent
      Returns:
      API client

    • setTempFolderPath

      public ApiClient setTempFolderPath(String tempFolderPath)
      Set temp folder path
      Parameters:
      tempFolderPath - Temp folder path
      Returns:
      API client

    • addDefaultHeader

      public ApiClient addDefaultHeader(String key, String value)
      Add a default header.
      Parameters:
      key - The header's key
      value - The header's value
      Returns:
      API client

    • addDefaultCookie

      public ApiClient addDefaultCookie(String key, String value)
      Add a default cookie.
      Parameters:
      key - The cookie's key
      value - The cookie's value
      Returns:
      API client

    • isDebugging

      public boolean isDebugging()
      Check that whether debugging is enabled for this API client.
      Returns:
      True if debugging is on

    • setDebugging

      public ApiClient setDebugging(boolean debugging)
      Enable/disable debugging for this API client.
      Parameters:
      debugging - To enable (true) or disable (false) debugging
      Returns:
      API client

    • getConnectTimeout

      public int getConnectTimeout()
      Connect timeout (in milliseconds).
      Returns:
      Connection timeout

    • setConnectTimeout

      public ApiClient setConnectTimeout(int connectionTimeout)
      Set the connect timeout (in milliseconds). A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE.
      Parameters:
      connectionTimeout - Connection timeout in milliseconds
      Returns:
      API client

    • getDateFormat

      public DateFormat getDateFormat()
      Get the date format used to parse/format date parameters.
      Returns:
      Date format

    • setDateFormat

      public ApiClient setDateFormat(DateFormat dateFormat)
      Set the date format used to parse/format date parameters.
      Parameters:
      dateFormat - Date format
      Returns:
      API client

    • parseDate

      public Date parseDate(String str)
      Parse the given string into Date object.
      Parameters:
      str - String
      Returns:
      Date

    • formatDate

      public String formatDate(Date date)
      Format the given Date object into string.
      Parameters:
      date - Date
      Returns:
      Date in string format

    • parameterToString

      public String parameterToString(Object param)
      Format the given parameter object into string.
      Parameters:
      param - Object
      Returns:
      Object in string format

    • parameterToPair

      public List<Pair> parameterToPair(String name, Object value)
      Formats the specified query parameter to a list containing a single Pair object. Note that value must not be a collection.
      Parameters:
      name - The name of the parameter.
      value - The value of the parameter.
      Returns:
      A list containing a single Pair object.

    • parameterToPairs

      public List<Pair> parameterToPairs(String collectionFormat, String name, Collection value)
      Formats the specified collection query parameters to a list of Pair objects. Note that the values of each of the returned Pair objects are percent-encoded.
      Parameters:
      collectionFormat - The collection format of the parameter.
      name - The name of the parameter.
      value - The value of the parameter.
      Returns:
      A list of Pair objects.

    • isJsonMime

      public boolean isJsonMime(String mime)
      Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
      Parameters:
      mime - MIME
      Returns:
      True if MIME type is boolean

    • selectHeaderAccept

      public String selectHeaderAccept(String[] accepts)
      Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
      Parameters:
      accepts - The accepts array to select from
      Returns:
      The Accept header to use. If the given array is empty, null will be returned (not to set the Accept header explicitly).

    • selectHeaderContentType

      public String selectHeaderContentType(String[] contentTypes)
      Select the Content-Type header's value from the given array: if JSON exists in the given array, use it; otherwise use the first one of the array.
      Parameters:
      contentTypes - The Content-Type array to select from
      Returns:
      The Content-Type header to use. If the given array is empty, or matches "any", JSON will be used.

    • escapeString

      public String escapeString(String str)
      Escape the given string to be used as URL query value.
      Parameters:
      str - String
      Returns:
      Escaped string

    • transformResponseHeaders

      protected Map<String,List<String>> transformResponseHeaders(org.apache.hc.core5.http.Header[] headers)
      Transforms response headers into map.
      Parameters:
      headers - HTTP headers
      Returns:
      a map of string array

    • serialize

      public org.apache.hc.core5.http.HttpEntity serialize(Object obj, Map<String,Object> formParams, org.apache.hc.core5.http.ContentType contentType) throws ApiException
      Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).
      Parameters:
      obj - Object
      contentType - Content type
      formParams - Form parameters
      Returns:
      Object
      Throws:
      ApiException - API exception

    • deserialize

      public <T> T deserialize(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> valueType) throws ApiException, IOException, org.apache.hc.core5.http.ParseException
      Deserialize response body to Java object according to the Content-Type.
      Type Parameters:
      T - Type
      Parameters:
      response - Response
      valueType - Return type
      Returns:
      Deserialized object
      Throws:
      ApiException - API exception
      IOException - IO exception
      org.apache.hc.core5.http.ParseException

    • prepareDownloadFile

      protected File prepareDownloadFile(String contentDisposition) throws IOException
      Throws:
      IOException

    • getBaseURL

      public String getBaseURL()
      Returns the URL of the client as defined by the server (if exists) or the base path.
      Returns:
      The URL for the client.

    • isSuccessfulStatus

      protected boolean isSuccessfulStatus(int statusCode)

    • isBodyAllowed

      protected boolean isBodyAllowed(String method)

    • buildCookie

      protected org.apache.hc.client5.http.cookie.Cookie buildCookie(String key, String value, URI uri)

    • processResponse

      protected <T> T processResponse(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> returnType) throws ApiException, IOException, org.apache.hc.core5.http.ParseException
      Throws:
      ApiException
      IOException
      org.apache.hc.core5.http.ParseException

    • invokeAPI

      public <T> T invokeAPI(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, String urlQueryDeepObject, Object body, Map<String,String> headerParams, Map<String,String> cookieParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, com.fasterxml.jackson.core.type.TypeReference<T> returnType) throws ApiException
      Invoke API by sending HTTP request with the given options.
      Type Parameters:
      T - Type
      Parameters:
      path - The sub-path of the HTTP URL
      method - The request method, one of "GET", "POST", "PUT", and "DELETE"
      queryParams - The query parameters
      collectionQueryParams - The collection query parameters
      urlQueryDeepObject - A URL query string for deep object parameters
      body - The request body object - if it is not binary, otherwise null
      headerParams - The header parameters
      cookieParams - The cookie parameters
      formParams - The form parameters
      accept - The request's Accept header
      contentType - The request's Content-Type header
      authNames - The authentications to apply
      returnType - Return type
      Returns:
      The response body in type of string
      Throws:
      ApiException - API exception