ApiClient (Okta Java SDK 12.0.2 API)

java.lang.Object
- org.openapitools.client.JavaTimeFormatter
- - org.openapitools.client.ApiClient

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class ApiClient
extends JavaTimeFormatter

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`serverIndex`
`protected List<ServerConfiguration>`	`servers`
`protected Map<String,String>`	`serverVariables`
`protected String`	`tempFolderPath`

Constructor Summary

Constructors
Constructor and Description
`ApiClient()`
`ApiClient(org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient, CacheManager cacheManager, com.okta.commons.http.config.HttpClientConfiguration httpClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiClient`	`addDefaultCookie(String key, String value)` Add a default cookie.
`ApiClient`	`addDefaultHeader(String key, String value)` Add a default header.
`protected org.apache.hc.client5.http.cookie.Cookie`	`buildCookie(String key, String value, URI uri)`
`static DateFormat`	`buildDefaultDateFormat()`
`<T> T`	`deserialize(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> valueType)` Deserialize response body to Java object according to the Content-Type.
`String`	`escapeString(String str)` Escape the given string to be used as URL query value.
`String`	`formatDate(Date date)` Format the given Date object into string.
`Authentication`	`getAuthentication(String authName)` Get authentication for the given name.
`Map<String,Authentication>`	`getAuthentications()` Get authentications (key: authentication name, value: authentication).
`String`	`getBasePath()`
`int`	`getConnectTimeout()` Connect timeout (in milliseconds).
`DateFormat`	`getDateFormat()` Get the date format used to parse/format date parameters.
`org.apache.hc.client5.http.impl.classic.CloseableHttpClient`	`getHttpClient()`
`com.fasterxml.jackson.databind.ObjectMapper`	`getObjectMapper()` Returns the current object mapper used for JSON serialization/deserialization.
`Map<String,List<String>>`	`getResponseHeaders()` Gets the response headers of the previous request
`Integer`	`getServerIndex()`
`List<ServerConfiguration>`	`getServers()`
`Map<String,String>`	`getServerVariables()`
`int`	`getStatusCode()` Gets the status code of the previous request
`String`	`getTempFolderPath()` The path of temporary folder used to store downloaded files from endpoints with file response.
`<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)` Invoke API by sending HTTP request with the given options.
`protected boolean`	`isBodyAllowed(String method)`
`boolean`	`isDebugging()` Check that whether debugging is enabled for this API client.
`boolean`	`isJsonMime(String mime)` Check if the given MIME is a JSON MIME.
`protected boolean`	`isSuccessfulStatus(int statusCode)`
`List<Pair>`	`parameterToPair(String name, Object value)` Formats the specified query parameter to a list containing a single `Pair` object.
`List<Pair>`	`parameterToPairs(String collectionFormat, String name, Collection value)` Formats the specified collection query parameters to a list of `Pair` objects.
`String`	`parameterToString(Object param)` Format the given parameter object into string.
`Date`	`parseDate(String str)` Parse the given string into Date object.
`protected File`	`prepareDownloadFile(String contentDisposition)`
`protected <T> T`	`processResponse(org.apache.hc.client5.http.impl.classic.CloseableHttpResponse response, com.fasterxml.jackson.core.type.TypeReference<T> returnType)`
`void`	`replaceAuthentication(String authName, Authentication authentication)` Replaces authentication for the given name.
`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)
`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.
`org.apache.hc.core5.http.HttpEntity`	`serialize(Object obj, Map<String,Object> formParams, org.apache.hc.core5.http.ContentType contentType)` Serialize the given Java object into string according the given Content-Type (only JSON is supported for now).
`ApiClient`	`setAccessToken(String accessToken)` Helper method to set access token for the first OAuth2 authentication.
`ApiClient`	`setApiKey(String apiKey)` Helper method to set API key value for the first API key authentication.
`ApiClient`	`setApiKeyPrefix(String apiKeyPrefix)` Helper method to set API key prefix for the first API key authentication.
`ApiClient`	`setBasePath(String basePath)` Sets the base path.
`ApiClient`	`setConnectTimeout(int connectionTimeout)` Set the connect timeout (in milliseconds).
`ApiClient`	`setDateFormat(DateFormat dateFormat)` Set the date format used to parse/format date parameters.
`ApiClient`	`setDebugging(boolean debugging)` Enable/disable debugging for this API client.
`ApiClient`	`setHttpClient(org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient)` Sets the HTTP client.
`ApiClient`	`setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Sets the object mapper.
`ApiClient`	`setServerIndex(Integer serverIndex)` Sets the server index.
`ApiClient`	`setServers(List<ServerConfiguration> servers)` Sets the server.
`ApiClient`	`setServerVariables(Map<String,String> serverVariables)` Sets the server variables.
`ApiClient`	`setTempFolderPath(String tempFolderPath)` Set temp folder path
`ApiClient`	`setUserAgent(String userAgent)` Set the User-Agent header's value (by adding to the default header map).
`protected Map<String,List<String>>`	`transformResponseHeaders(org.apache.hc.core5.http.Header[] headers)` Transforms response headers into map.

Methods inherited from class org.openapitools.client.JavaTimeFormatter
formatOffsetDateTime, getOffsetDateTimeFormatter, parseOffsetDateTime, setOffsetDateTimeFormatter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - servers
```
protected List<ServerConfiguration> servers
```
  - serverIndex
```
protected Integer serverIndex
```
  - serverVariables
```
protected Map<String,String> serverVariables
```
  - tempFolderPath
```
protected String tempFolderPath
```
- Constructor Detail
  - ApiClient
```
public ApiClient(org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient,
                 CacheManager cacheManager,
                 com.okta.commons.http.config.HttpClientConfiguration httpClientConfiguration)
```
  - ApiClient
```
public ApiClient()
```
- Method Detail
  - 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
  - replaceAuthentication
```
public void replaceAuthentication(String authName,
                                  Authentication authentication)
```
    Replaces authentication for the given name.
    
    Parameters:
    
    authName - The authentication name
    
    authentication - The new implementation (must be of the same type of the existing implementation)
  - 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
  - setApiKey
```
public ApiClient setApiKey(String apiKey)
```
    Helper method to set API key value for the first API key authentication.
    
    Parameters:
    
    apiKey - the API key
    
    Returns:
    
    API client
  - setApiKeyPrefix
```
public ApiClient setApiKeyPrefix(String apiKeyPrefix)
```
    Helper method to set API key prefix for the first API key authentication.
    
    Parameters:
    
    apiKeyPrefix - API key prefix
    
    Returns:
    
    API client
  - setAccessToken
```
public ApiClient setAccessToken(String accessToken)
```
    Helper method to set access token for the first OAuth2 authentication.
    
    Parameters:
    
    accessToken - Access token
    
    Returns:
    
    API client
  - 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
  - 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

Class ApiClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.openapitools.client.JavaTimeFormatter

Methods inherited from class java.lang.Object

Field Detail

servers

serverIndex

serverVariables

tempFolderPath

Constructor Detail

ApiClient

ApiClient

Method Detail

buildDefaultDateFormat

getObjectMapper

setObjectMapper

getHttpClient

setHttpClient

getBasePath

setBasePath

getServers

setServers

getServerIndex

setServerIndex

getServerVariables

setServerVariables

getStatusCode

getResponseHeaders

getAuthentications

getAuthentication

replaceAuthentication

getTempFolderPath

setApiKey

setApiKeyPrefix

setAccessToken

setUserAgent

setTempFolderPath

addDefaultHeader

addDefaultCookie

isDebugging

setDebugging

getConnectTimeout

setConnectTimeout

getDateFormat

setDateFormat

parseDate

formatDate

parameterToString

parameterToPair

parameterToPairs

isJsonMime

selectHeaderAccept

selectHeaderContentType

escapeString

transformResponseHeaders

serialize

deserialize

prepareDownloadFile

isSuccessfulStatus

isBodyAllowed

buildCookie

processResponse

invokeAPI