public class ApiClient
extends java.lang.Object
Constructor and Description |
---|
ApiClient() |
Modifier and Type | Method and Description |
---|---|
ApiClient |
addDefaultHeader(java.lang.String key,
java.lang.String value)
Add a default header.
|
com.squareup.okhttp.Call |
buildCall(java.lang.String path,
java.lang.String method,
java.util.List<Pair> queryParams,
java.util.List<Pair> collectionQueryParams,
java.lang.Object body,
java.util.Map<java.lang.String,java.lang.String> headerParams,
java.util.Map<java.lang.String,java.lang.Object> formParams,
java.lang.String[] authNames,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build HTTP call with the given options.
|
com.squareup.okhttp.Request |
buildRequest(java.lang.String path,
java.lang.String method,
java.util.List<Pair> queryParams,
java.util.List<Pair> collectionQueryParams,
java.lang.Object body,
java.util.Map<java.lang.String,java.lang.String> headerParams,
java.util.Map<java.lang.String,java.lang.Object> formParams,
java.lang.String[] authNames,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build an HTTP request with the given options.
|
com.squareup.okhttp.RequestBody |
buildRequestBodyFormEncoding(java.util.Map<java.lang.String,java.lang.Object> formParams)
Build a form-encoding request body with the given form parameters.
|
com.squareup.okhttp.RequestBody |
buildRequestBodyMultipart(java.util.Map<java.lang.String,java.lang.Object> formParams)
Build a multipart (file uploading) request body with the given form parameters,
which could contain text fields and file fields.
|
java.lang.String |
buildUrl(java.lang.String path,
java.util.List<Pair> queryParams,
java.util.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,
java.lang.reflect.Type returnType)
Deserialize response body to Java object, according to the return type and
the Content-Type response header.
|
java.io.File |
downloadFileFromResponse(com.squareup.okhttp.Response response)
Download file from the given response.
|
java.lang.String |
escapePathSegmentString(java.lang.String str)
Escape the given string to be used as URL segment value.
|
java.lang.String |
escapeString(java.lang.String str)
Escape the given string to be used as URL query value.
|
<T> ApiResponse<T> |
execute(com.squareup.okhttp.Call call)
|
<T> ApiResponse<T> |
execute(com.squareup.okhttp.Call call,
java.lang.reflect.Type returnType)
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)
|
<T> void |
executeAsync(com.squareup.okhttp.Call call,
java.lang.reflect.Type returnType,
ApiCallback<T> callback)
Execute HTTP call asynchronously.
|
java.lang.String |
getAppKey()
Get App Key
|
java.lang.String |
getAppSid()
Get App Sid
|
java.lang.String |
getBasePath()
Get base path
|
int |
getConnectTimeout()
Get connection timeout (in milliseconds).
|
com.squareup.okhttp.OkHttpClient |
getHttpClient()
Get HTTP client
|
JSON |
getJSON()
Get JSON
|
int |
getReadTimeout()
Get read timeout (in milliseconds).
|
java.lang.String |
getTempFolderPath()
The path of temporary folder used to store downloaded files from endpoints
with file response.
|
int |
getWriteTimeout()
Get write timeout (in milliseconds).
|
java.lang.String |
guessContentTypeFromFile(java.io.File file)
Guess Content-Type header from the given file (defaults to "application/octet-stream").
|
<T> T |
handleResponse(com.squareup.okhttp.Response response,
java.lang.reflect.Type returnType)
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(java.lang.String mime)
Check if the given MIME is a JSON MIME.
|
java.util.List<Pair> |
parameterToPair(java.lang.String name,
java.lang.Object value)
Formats the specified query parameter to a list containing a single
Pair object. |
java.util.List<Pair> |
parameterToPairs(java.lang.String collectionFormat,
java.lang.String name,
java.util.Collection value)
Formats the specified collection query parameters to a list of
Pair objects. |
java.lang.String |
parameterToString(java.lang.Object param)
Format the given parameter object into string.
|
java.io.File |
prepareDownloadFile(com.squareup.okhttp.Response response)
Prepare file for download
|
void |
processHeaderParams(java.util.Map<java.lang.String,java.lang.String> headerParams,
com.squareup.okhttp.Request.Builder reqBuilder)
Set header parameters to the request builder, including default headers.
|
void |
requestToken()
Request OAuth token
|
java.lang.String |
sanitizeFilename(java.lang.String filename)
Sanitize filename by removing path.
|
java.lang.String |
selectHeaderAccept(java.lang.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)
|
java.lang.String |
selectHeaderContentType(java.lang.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(java.lang.Object obj,
java.lang.String contentType)
Serialize the given Java object into request body according to the object's
class and the request Content-Type.
|
void |
setAccessToken(java.lang.String accessToken)
Set access token for the OAuth2 authentication.
|
void |
setAppKey(java.lang.String appKey)
Set App Key
|
void |
setAppSid(java.lang.String appSid)
Set App Sid
|
ApiClient |
setBasePath(java.lang.String basePath)
Set base path
|
ApiClient |
setConnectTimeout(int connectionTimeout)
Sets the connect timeout (in milliseconds).
|
ApiClient |
setDebugging(boolean debugging)
Enable/disable debugging for this API client.
|
ApiClient |
setHttpClient(com.squareup.okhttp.OkHttpClient httpClient)
Set HTTP client
|
ApiClient |
setJSON(JSON json)
Set JSON
|
ApiClient |
setLenientOnJson(boolean lenientOnJson) |
ApiClient |
setReadTimeout(int readTimeout)
Sets the read timeout (in milliseconds).
|
ApiClient |
setTempFolderPath(java.lang.String tempFolderPath)
Set the temporary folder path (for downloading files)
|
ApiClient |
setUserAgent(java.lang.String userAgent)
Set the User-Agent header's value (by adding to the default header map).
|
ApiClient |
setWriteTimeout(int writeTimeout)
Sets the write timeout (in milliseconds).
|
public java.lang.String getAppKey()
public void setAppKey(java.lang.String appKey)
appKey
- App Keypublic java.lang.String getAppSid()
public void setAppSid(java.lang.String appSid)
appSid
- App Sidpublic java.lang.String getBasePath()
public ApiClient setBasePath(java.lang.String basePath)
basePath
- Base path of the URL (e.g https://api.aspose.cloud/v3.0public com.squareup.okhttp.OkHttpClient getHttpClient()
public ApiClient setHttpClient(com.squareup.okhttp.OkHttpClient httpClient)
httpClient
- An instance of OkHttpClientpublic JSON getJSON()
public ApiClient setJSON(JSON json)
json
- JSON objectpublic ApiClient setLenientOnJson(boolean lenientOnJson)
public void setAccessToken(java.lang.String accessToken)
accessToken
- Access tokenpublic ApiClient setUserAgent(java.lang.String userAgent)
userAgent
- HTTP request's user agentpublic ApiClient addDefaultHeader(java.lang.String key, java.lang.String value)
key
- The header's keyvalue
- The header's valuepublic boolean isDebugging()
public ApiClient setDebugging(boolean debugging)
debugging
- To enable (true) or disable (false) debuggingpublic java.lang.String getTempFolderPath()
null
, i.e. using
the system's default tempopary folder.public ApiClient setTempFolderPath(java.lang.String tempFolderPath)
tempFolderPath
- Temporary folder pathpublic int getConnectTimeout()
public ApiClient setConnectTimeout(int connectionTimeout)
Integer.MAX_VALUE
.connectionTimeout
- connection timeout in millisecondspublic int getReadTimeout()
public ApiClient setReadTimeout(int readTimeout)
Integer.MAX_VALUE
.readTimeout
- read timeout in millisecondspublic int getWriteTimeout()
public ApiClient setWriteTimeout(int writeTimeout)
Integer.MAX_VALUE
.writeTimeout
- connection timeout in millisecondspublic java.lang.String parameterToString(java.lang.Object param)
param
- Parameterpublic java.util.List<Pair> parameterToPair(java.lang.String name, java.lang.Object value)
Pair
object.
Note that value
must not be a collection.name
- The name of the parameter.value
- The value of the parameter.Pair
object.public java.util.List<Pair> parameterToPairs(java.lang.String collectionFormat, java.lang.String name, java.util.Collection value)
Pair
objects.
Note that the values of each of the returned Pair objects are percent-encoded.collectionFormat
- The collection format of the parameter.name
- The name of the parameter.value
- The value of the parameter.Pair
objects.public java.lang.String sanitizeFilename(java.lang.String filename)
filename
- The filename to be sanitizedpublic boolean isJsonMime(java.lang.String mime)
mime
- MIME (Multipurpose Internet Mail Extensions)public java.lang.String selectHeaderAccept(java.lang.String[] accepts)
accepts
- The accepts array to select frompublic java.lang.String selectHeaderContentType(java.lang.String[] contentTypes)
contentTypes
- The Content-Type array to select frompublic java.lang.String escapeString(java.lang.String str)
str
- String to be escapedpublic java.lang.String escapePathSegmentString(java.lang.String str)
str
- String to be escapedpublic <T> T deserialize(com.squareup.okhttp.Response response, java.lang.reflect.Type returnType) throws ApiException
T
- Typeresponse
- HTTP responsereturnType
- The type of the Java objectApiException
- If fail to deserialize response body, i.e. cannot read response body
or the Content-Type of the response is not supported.public com.squareup.okhttp.RequestBody serialize(java.lang.Object obj, java.lang.String contentType) throws ApiException
obj
- The Java objectcontentType
- The request Content-TypeApiException
- If fail to serialize the given objectpublic java.io.File downloadFileFromResponse(com.squareup.okhttp.Response response) throws ApiException
response
- An instance of the Response objectApiException
- If fail to read file content from response and write to diskpublic java.io.File prepareDownloadFile(com.squareup.okhttp.Response response) throws java.io.IOException
response
- An instance of the Response objectjava.io.IOException
- If fail to prepare file for downloadpublic <T> ApiResponse<T> execute(com.squareup.okhttp.Call call) throws ApiException
T
- Typecall
- An instance of the Call objectApiException
- If fail to execute the callpublic <T> ApiResponse<T> execute(com.squareup.okhttp.Call call, java.lang.reflect.Type returnType) throws ApiException
T
- The return type corresponding to (same with) returnTypereturnType
- The return type used to deserialize HTTP response bodycall
- CallApiException
- If fail to execute the callpublic <T> void executeAsync(com.squareup.okhttp.Call call, ApiCallback<T> callback)
T
- Typecall
- An instance of the Call objectcallback
- ApiCallback<T>public <T> void executeAsync(com.squareup.okhttp.Call call, java.lang.reflect.Type returnType, ApiCallback<T> callback)
T
- Typecall
- The callback to be executed when the API call finishesreturnType
- Return typecallback
- ApiCallbackexecute(Call, Type)
public <T> T handleResponse(com.squareup.okhttp.Response response, java.lang.reflect.Type returnType) throws ApiException
T
- Typeresponse
- ResponsereturnType
- Return typeApiException
- If the response has a unsuccessful status code or
fail to deserialize the response bodypublic com.squareup.okhttp.Call buildCall(java.lang.String path, java.lang.String method, java.util.List<Pair> queryParams, java.util.List<Pair> collectionQueryParams, java.lang.Object body, java.util.Map<java.lang.String,java.lang.String> headerParams, java.util.Map<java.lang.String,java.lang.Object> formParams, java.lang.String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
path
- The sub-path of the HTTP URLmethod
- The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"queryParams
- The query parameterscollectionQueryParams
- The collection query parametersbody
- The request body objectheaderParams
- The header parametersformParams
- The form parametersauthNames
- The authentications to applyprogressRequestListener
- Progress request listenerApiException
- If fail to serialize the request body objectpublic com.squareup.okhttp.Request buildRequest(java.lang.String path, java.lang.String method, java.util.List<Pair> queryParams, java.util.List<Pair> collectionQueryParams, java.lang.Object body, java.util.Map<java.lang.String,java.lang.String> headerParams, java.util.Map<java.lang.String,java.lang.Object> formParams, java.lang.String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
path
- The sub-path of the HTTP URLmethod
- The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"queryParams
- The query parameterscollectionQueryParams
- The collection query parametersbody
- The request body objectheaderParams
- The header parametersformParams
- The form parametersauthNames
- The authentications to applyprogressRequestListener
- Progress request listenerApiException
- If fail to serialize the request body objectpublic java.lang.String buildUrl(java.lang.String path, java.util.List<Pair> queryParams, java.util.List<Pair> collectionQueryParams)
path
- The sub pathqueryParams
- The query parameterscollectionQueryParams
- The collection query parameterspublic void processHeaderParams(java.util.Map<java.lang.String,java.lang.String> headerParams, com.squareup.okhttp.Request.Builder reqBuilder)
headerParams
- Header parameters in the ofrm of MapreqBuilder
- Reqeust.Builderpublic com.squareup.okhttp.RequestBody buildRequestBodyFormEncoding(java.util.Map<java.lang.String,java.lang.Object> formParams)
formParams
- Form parameters in the form of Mappublic com.squareup.okhttp.RequestBody buildRequestBodyMultipart(java.util.Map<java.lang.String,java.lang.Object> formParams)
formParams
- Form parameters in the form of Mappublic java.lang.String guessContentTypeFromFile(java.io.File file)
file
- The given filepublic void requestToken() throws ApiException
ApiException
- If fail to request token