com.volcengine

Class ApiClient

java.lang.Object

com.volcengine.ApiClient

public class ApiClient
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiClient()

Method Summary

Modifier and Type	Method and Description
ApiClient	addDefaultHeader(String key, String value) Add a default header.
com.squareup.okhttp.Call	buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String,String> headerParams, Map<String,Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener, boolean... isCommon) Build HTTP call with the given options.
com.squareup.okhttp.Request	buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String,String> headerParams, Map<String,Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener, boolean... isCommon) Build an HTTP request with the given options.
com.squareup.okhttp.RequestBody	buildRequestBodyFormEncoding(Map<String,Object> formParams) Build a form-encoding request body with the given form parameters.
com.squareup.okhttp.RequestBody	buildRequestBodyMultipart(Map<String,Object> formParams) Build a multipart (file uploading) request body with the given form parameters, which could contain text fields and file fields.
String	buildUrl(String path, List<Pair> queryParams, List<Pair> collectionQueryParams) Build full URL by concatenating base path, the given sub path and query parameters.
<T> T	deserialize(com.squareup.okhttp.Response response, Type returnType, boolean... isCommon) Deserialize response body to Java object, according to the return type and the Content-Type response header.
File	downloadFileFromResponse(com.squareup.okhttp.Response response) Download file from the given response.
String	escapeString(String str) Escape the given string to be used as URL query value.
<T> ApiResponse<T>	execute(com.squareup.okhttp.Call call) execute(Call, Type, boolean...)
<T> ApiResponse<T>	execute(com.squareup.okhttp.Call call, Type returnType, boolean... isCommon) Execute HTTP call and deserialize the HTTP response body into the given return type.
<T> void	executeAsync(com.squareup.okhttp.Call call, ApiCallback<T> callback) executeAsync(Call, Type, ApiCallback)
<T> void	executeAsync(com.squareup.okhttp.Call call, Type returnType, ApiCallback<T> callback) Execute HTTP call asynchronously.
Authentication	getAuthentication(String authName) Get authentication for the given name.
Map<String,Authentication>	getAuthentications() Get authentications (key: authentication name, value: authentication).
int	getConnectTimeout() Get connection timeout (in milliseconds).
Credentials	getCredentials() Get credentials
DateFormat	getDateFormat()
boolean	getDisableSSL() Get disableSSL
String	getEndpoint() Get base path
com.squareup.okhttp.OkHttpClient	getHttpClient() Get HTTP client
JSON	getJSON() Get JSON
KeyManager[]	getKeyManagers()
int	getReadTimeout() Get read timeout (in milliseconds).
String	getRegion() Get region
InputStream	getSslCaCert() Get SSL CA cert.
String	getTempFolderPath() The path of temporary folder used to store downloaded files from endpoints with file response.
int	getWriteTimeout() Get write timeout (in milliseconds).
String	guessContentTypeFromFile(File file) Guess Content-Type header from the given file (defaults to "application/octet-stream").
<T> T	handleResponse(com.squareup.okhttp.Response response, Type returnType, boolean... isCommon) Handle the given response, return the deserialized object when the response is successful.
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.
boolean	isVerifyingSsl() True if isVerifyingSsl flag is on
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.
File	prepareDownloadFile(com.squareup.okhttp.Response response) Prepare file for download
void	processHeaderParams(Map<String,String> headerParams, com.squareup.okhttp.Request.Builder reqBuilder) Set header parameters to the request builder, including default headers.
String	sanitizeFilename(String filename) Sanitize filename by removing path.
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.
com.squareup.okhttp.RequestBody	serialize(Object obj, String contentType) Serialize the given Java object into request body according to the object's class and the request Content-Type.
ApiClient	setConnectTimeout(int connectionTimeout) Sets the connect timeout (in milliseconds).
ApiClient	setCredentials(Credentials credentials) Set credentials
ApiClient	setDateFormat(DateFormat dateFormat)
ApiClient	setDebugging(boolean debugging) Enable/disable debugging for this API client.
ApiClient	setDisableSSL(boolean disableSSL) Set disableSSL
ApiClient	setEndpoint(String endpoint) Set base path
ApiClient	setHttpClient(com.squareup.okhttp.OkHttpClient httpClient) Set HTTP client
ApiClient	setJSON(JSON json) Set JSON
ApiClient	setKeyManagers(KeyManager[] managers) Configure client keys to use for authorization in an SSL session.
ApiClient	setLenientOnJson(boolean lenientOnJson)
ApiClient	setLocalDateFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)
ApiClient	setOffsetDateTimeFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)
ApiClient	setReadTimeout(int readTimeout) Sets the read timeout (in milliseconds).
ApiClient	setRegion(String region) Set region
ApiClient	setSqlDateFormat(DateFormat dateFormat)
ApiClient	setSslCaCert(InputStream sslCaCert) Configure the CA certificate to be trusted when making https requests.
ApiClient	setTempFolderPath(String tempFolderPath) Set the temporary folder path (for downloading files)
ApiClient	setUserAgent(String userAgent) Set the User-Agent header's value (by adding to the default header map).
ApiClient	setVerifyingSsl(boolean verifyingSsl) Configure whether to verify certificate and hostname when making https requests.
ApiClient	setWriteTimeout(int writeTimeout) Sets the write timeout (in milliseconds).
void	updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String,String> headerParams) Update query and header parameters based on authentication settings.
void	updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String,String> headerParams, ServiceInfo serviceInfo, String payload)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiClient

public ApiClient()

Method Detail

getEndpoint

public String getEndpoint()

Get base path

Returns:

Baes path

setEndpoint

public ApiClient setEndpoint(String endpoint)

Set base path

Parameters:

endpoint - endpoint of the URL

Returns:

An instance of OkHttpClient

getDisableSSL

public boolean getDisableSSL()

Get disableSSL

Returns:

Baes path

setDisableSSL

public ApiClient setDisableSSL(boolean disableSSL)

Set disableSSL

Parameters:

disableSSL -

Returns:

An instance of OkHttpClient

getRegion

public String getRegion()

Get region

Returns:

Baes path

setRegion

public ApiClient setRegion(String region)

Set region

Parameters:

region -

Returns:

An instance of OkHttpClient

getCredentials

public Credentials getCredentials()

Get credentials

Returns:

Baes path

setCredentials

public ApiClient setCredentials(Credentials credentials)

Set credentials

Parameters:

credentials -

Returns:

An instance of OkHttpClient

getHttpClient

public com.squareup.okhttp.OkHttpClient getHttpClient()

Get HTTP client

Returns:

An instance of OkHttpClient

setHttpClient

public ApiClient setHttpClient(com.squareup.okhttp.OkHttpClient httpClient)

Set HTTP client

Parameters:

httpClient - An instance of OkHttpClient

Returns:

Api Client

getJSON

public JSON getJSON()

Get JSON

Returns:

JSON object

setJSON

public ApiClient setJSON(JSON json)

Set JSON

Parameters:

json - JSON object

Returns:

Api client

isVerifyingSsl

public boolean isVerifyingSsl()

True if isVerifyingSsl flag is on

Returns:

True if isVerifySsl flag is on

setVerifyingSsl

public ApiClient setVerifyingSsl(boolean verifyingSsl)

Configure whether to verify certificate and hostname when making https requests. Default to true. NOTE: Do NOT set to false in production code, otherwise you would face multiple types of cryptographic attacks.

Parameters:

verifyingSsl - True to verify TLS/SSL connection

Returns:

ApiClient

getSslCaCert

public InputStream getSslCaCert()

Get SSL CA cert.

Returns:

Input stream to the SSL CA cert

setSslCaCert

public ApiClient setSslCaCert(InputStream sslCaCert)

Configure the CA certificate to be trusted when making https requests. Use null to reset to default.

Parameters:

sslCaCert - input stream for SSL CA cert

Returns:

ApiClient

getKeyManagers

public KeyManager[] getKeyManagers()

setKeyManagers

public ApiClient setKeyManagers(KeyManager[] managers)

Configure client keys to use for authorization in an SSL session. Use null to reset to default.

Parameters:

managers - The KeyManagers to use

Returns:

ApiClient

getDateFormat

public DateFormat getDateFormat()

setDateFormat

public ApiClient setDateFormat(DateFormat dateFormat)

setSqlDateFormat

public ApiClient setSqlDateFormat(DateFormat dateFormat)

setOffsetDateTimeFormat

public ApiClient setOffsetDateTimeFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)

setLocalDateFormat

public ApiClient setLocalDateFormat(org.threeten.bp.format.DateTimeFormatter dateFormat)

setLenientOnJson

public ApiClient setLenientOnJson(boolean lenientOnJson)

getAuthentications

public Map<String,Authentication> getAuthentications()

Get authentications (key: authentication name, value: authentication).

Returns:

Map of authentication objects

getAuthentication

public Authentication getAuthentication(String authName)

Get authentication for the given name.

Parameters:

authName - The authentication name

Returns:

The authentication, null if not found

setUserAgent

public ApiClient setUserAgent(String userAgent)

Set the User-Agent header's value (by adding to the default header map).

Parameters:

userAgent - HTTP request's user agent

Returns:

ApiClient

addDefaultHeader

public ApiClient addDefaultHeader(String key,
                                  String value)

Add a default header.

Parameters:

key - The header's key

value - The header's value

Returns:

ApiClient

isDebugging

public boolean isDebugging()

Check that whether debugging is enabled for this API client.

Returns:

True if debugging is enabled, false otherwise.

setDebugging

public ApiClient setDebugging(boolean debugging)

Enable/disable debugging for this API client.

Parameters:

debugging - To enable (true) or disable (false) debugging

Returns:

ApiClient

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 tempopary folder.

Returns:

Temporary folder path

See Also:

createTempFile

setTempFolderPath

public ApiClient setTempFolderPath(String tempFolderPath)

Set the temporary folder path (for downloading files)

Parameters:

tempFolderPath - Temporary folder path

Returns:

ApiClient

getConnectTimeout

public int getConnectTimeout()

Get connection timeout (in milliseconds).

Returns:

Timeout in milliseconds

setConnectTimeout

public ApiClient setConnectTimeout(int connectionTimeout)

Sets the connect timeout (in milliseconds). A value of 0 means no timeout, otherwise values must be between 1 and

Parameters:

connectionTimeout - connection timeout in milliseconds

Returns:

Api client

getReadTimeout

public int getReadTimeout()

Get read timeout (in milliseconds).

Returns:

Timeout in milliseconds

setReadTimeout

public ApiClient setReadTimeout(int readTimeout)

Sets the read timeout (in milliseconds). A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE.

Parameters:

readTimeout - read timeout in milliseconds

Returns:

Api client

getWriteTimeout

public int getWriteTimeout()

Get write timeout (in milliseconds).

Returns:

Timeout in milliseconds

setWriteTimeout

public ApiClient setWriteTimeout(int writeTimeout)

Sets the write timeout (in milliseconds). A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE.

Parameters:

writeTimeout - connection timeout in milliseconds

Returns:

Api client

parameterToString

public String parameterToString(Object param)

Format the given parameter object into string.

Parameters:

param - Parameter

Returns:

String representation of the parameter

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.

sanitizeFilename

public String sanitizeFilename(String filename)

Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif

Parameters:

filename - The filename to be sanitized

Returns:

The sanitized filename

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 "* / *" is also default to JSON

Parameters:

mime - MIME (Multipurpose Internet Mail Extensions)

Returns:

True if the given MIME is JSON, false otherwise.

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 to be escaped

Returns:

Escaped string

deserialize

public <T> T deserialize(com.squareup.okhttp.Response response,
                         Type returnType,
                         boolean... isCommon)
                  throws ApiException

Deserialize response body to Java object, according to the return type and the Content-Type response header.

Type Parameters:

T - Type

Parameters:

response - HTTP response

returnType - The type of the Java object

isCommon - The flag for Universal

Returns:

The deserialized Java object

Throws:

ApiException - If fail to deserialize response body, i.e. cannot read response body or the Content-Type of the response is not supported.

serialize

public com.squareup.okhttp.RequestBody serialize(Object obj,
                                                 String contentType)
                                          throws ApiException

Serialize the given Java object into request body according to the object's class and the request Content-Type.

Parameters:

obj - The Java object

contentType - The request Content-Type

Returns:

The serialized request body

Throws:

ApiException - If fail to serialize the given object

downloadFileFromResponse

public File downloadFileFromResponse(com.squareup.okhttp.Response response)
                              throws ApiException

Download file from the given response.

Parameters:

response - An instance of the Response object

Returns:

Downloaded file

Throws:

ApiException - If fail to read file content from response and write to disk

prepareDownloadFile

public File prepareDownloadFile(com.squareup.okhttp.Response response)
                         throws IOException

Prepare file for download

Parameters:

response - An instance of the Response object

Returns:

Prepared file for the download

Throws:

IOException - If fail to prepare file for download

execute

public <T> ApiResponse<T> execute(com.squareup.okhttp.Call call)
                           throws ApiException

execute(Call, Type, boolean...)

Type Parameters:

T - Type

Parameters:

call - An instance of the Call object

Returns:

ApiResponse<T>

Throws:

ApiException - If fail to execute the call

execute

public <T> ApiResponse<T> execute(com.squareup.okhttp.Call call,
                                  Type returnType,
                                  boolean... isCommon)
                           throws ApiException

Execute HTTP call and deserialize the HTTP response body into the given return type.

Type Parameters:

T - The return type corresponding to (same with) returnType

Parameters:

returnType - The return type used to deserialize HTTP response body

call - Call

isCommon - The flag for Universal

Returns:

ApiResponse object containing response status, headers and data, which is a Java object deserialized from response body and would be null when returnType is null.

Throws:

ApiException - If fail to execute the call

executeAsync

public <T> void executeAsync(com.squareup.okhttp.Call call,
                             ApiCallback<T> callback)

executeAsync(Call, Type, ApiCallback)

Type Parameters:

T - Type

Parameters:

call - An instance of the Call object

callback - ApiCallback<T>

executeAsync

public <T> void executeAsync(com.squareup.okhttp.Call call,
                             Type returnType,
                             ApiCallback<T> callback)

Execute HTTP call asynchronously.

Type Parameters:

T - Type

Parameters:

call - The callback to be executed when the API call finishes

returnType - Return type

callback - ApiCallback

See Also:

execute(Call, Type, boolean...)

handleResponse

public <T> T handleResponse(com.squareup.okhttp.Response response,
                            Type returnType,
                            boolean... isCommon)
                     throws ApiException

Handle the given response, return the deserialized object when the response is successful.

Type Parameters:

T - Type

Parameters:

response - Response

returnType - Return type

isCommon - The flag for Universal

Returns:

Type

Throws:

ApiException - If the response has a unsuccessful status code or fail to deserialize the response body

buildCall

public com.squareup.okhttp.Call buildCall(String path,
                                          String method,
                                          List<Pair> queryParams,
                                          List<Pair> collectionQueryParams,
                                          Object body,
                                          Map<String,String> headerParams,
                                          Map<String,Object> formParams,
                                          String[] authNames,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener,
                                          boolean... isCommon)
                                   throws ApiException

Build HTTP call with the given options.

Parameters:

path - The sub-path of the HTTP URL

method - The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"

queryParams - The query parameters

collectionQueryParams - The collection query parameters

body - The request body object

headerParams - The header parameters

formParams - The form parameters

authNames - The authentications to apply

progressRequestListener - Progress request listener

isCommon - The flag for Universal

Returns:

The HTTP call

Throws:

ApiException - If fail to serialize the request body object

buildRequest

public com.squareup.okhttp.Request buildRequest(String path,
                                                String method,
                                                List<Pair> queryParams,
                                                List<Pair> collectionQueryParams,
                                                Object body,
                                                Map<String,String> headerParams,
                                                Map<String,Object> formParams,
                                                String[] authNames,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener,
                                                boolean... isCommon)
                                         throws ApiException

Build an HTTP request with the given options.

Parameters:

path - The sub-path of the HTTP URL

method - The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"

queryParams - The query parameters

collectionQueryParams - The collection query parameters

body - The request body object

headerParams - The header parameters

formParams - The form parameters

authNames - The authentications to apply

progressRequestListener - Progress request listener

isCommon - The flag for Universal

Returns:

The HTTP request

Throws:

ApiException - If fail to serialize the request body object

buildUrl

public String buildUrl(String path,
                       List<Pair> queryParams,
                       List<Pair> collectionQueryParams)

Build full URL by concatenating base path, the given sub path and query parameters.

Parameters:

path - The sub path

queryParams - The query parameters

collectionQueryParams - The collection query parameters

Returns:

The full URL

processHeaderParams

public void processHeaderParams(Map<String,String> headerParams,
                                com.squareup.okhttp.Request.Builder reqBuilder)

Set header parameters to the request builder, including default headers.

Parameters:

headerParams - Header parameters in the ofrm of Map

reqBuilder - Reqeust.Builder

updateParamsForAuth

public void updateParamsForAuth(String[] authNames,
                                List<Pair> queryParams,
                                Map<String,String> headerParams)

Update query and header parameters based on authentication settings.

Parameters:

authNames - The authentications to apply

queryParams - List of query parameters

headerParams - Map of header parameters

updateParamsForAuth

public void updateParamsForAuth(String[] authNames,
                                List<Pair> queryParams,
                                Map<String,String> headerParams,
                                ServiceInfo serviceInfo,
                                String payload)

buildRequestBodyFormEncoding

public com.squareup.okhttp.RequestBody buildRequestBodyFormEncoding(Map<String,Object> formParams)

Build a form-encoding request body with the given form parameters.

Parameters:

formParams - Form parameters in the form of Map

Returns:

RequestBody

buildRequestBodyMultipart

public com.squareup.okhttp.RequestBody buildRequestBodyMultipart(Map<String,Object> formParams)

Build a multipart (file uploading) request body with the given form parameters, which could contain text fields and file fields.

Parameters:

formParams - Form parameters in the form of Map

Returns:

RequestBody

guessContentTypeFromFile

public String guessContentTypeFromFile(File file)

Guess Content-Type header from the given file (defaults to "application/octet-stream").

Parameters:

file - The given file

Returns:

The guessed Content-Type