com.fortanix.sdkms.v1

Class ApiClient

java.lang.Object

com.fortanix.sdkms.v1.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.
<T> T	deserialize(jakarta.ws.rs.core.Response response, jakarta.ws.rs.core.GenericType<T> returnType) Deserialize response body to Java object according to the Content-Type.
File	downloadFileFromResponse(jakarta.ws.rs.core.Response response) Download file from the given response.
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()
org.apache.http.pool.PoolStats	getConnectionStats() Get the connection pool statistics, only if maxConnections is set.
int	getConnectTimeout() Connect timeout (in milliseconds).
DateFormat	getDateFormat() Get the date format used to parse/format date parameters.
jakarta.ws.rs.client.Client	getHttpClient()
JSON	getJSON() Gets the JSON instance to do JSON serialization and deserialization.
long	getKeepAliveDuration() Custom connection keep alive duration in milliseconds.
int	getMaxConnections() Maximum http pooled connections to endpoint.
Map<String,List<String>>	getResponseHeaders() Gets the response headers of the previous request
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.
void	graceFullShutdown()
<T> T	invokeAPI(String path, String method, List<Pair> queryParams, Object body, Map<String,String> headerParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, jakarta.ws.rs.core.GenericType<T> returnType) Invoke API by sending HTTP request with the given options.
com.fortanix.sdkms.v1.ApiClient.ResponseWithMetadata	invokeAPIWithEndpoint(String endpoint, String path, jakarta.ws.rs.client.Entity entity, String method, List<Pair> queryParams, Object body, Map<String,String> headerParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames) Invoke API by sending HTTP request to a given endpoint with the given options.
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.
List<Pair>	parameterToPairs(String collectionFormat, String name, Object value)
String	parameterToString(Object param) Format the given parameter object into string.
Date	parseDate(String str) Parse the given string into Date object.
File	prepareDownloadFile(jakarta.ws.rs.core.Response response)
<T> T	processResponse(com.fortanix.sdkms.v1.ApiClient.ResponseWithMetadata responseWithMetadata, jakarta.ws.rs.core.GenericType<T> returnType) Deserialize the HTTP response to the provided type, also closes the HTTP response at the end of the function
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.
jakarta.ws.rs.client.Entity<?>	serialize(Object obj, Map<String,Object> formParams, String contentType) Serialize the given Java object into string entity according the given Content-Type (only JSON is supported for now).
void	setAccessToken(String accessToken) Helper method to set access token for the first OAuth2 authentication.
void	setApiKey(String apiKey) Helper method to set API key value for the first API key authentication.
void	setApiKeyPrefix(String apiKeyPrefix) Helper method to set API key prefix for the first API key authentication.
ApiClient	setBasePath(String basePath)
void	setBasicAuthString(String authString) Helper method to set username:password pair for the first HTTP basic authentication.
ApiClient	setClientSideFailoverEnabled(boolean isEnabled)
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	setEndpointHealthCheckInterval(int milliseconds)
ApiClient	setHostsResolutionStrategy(HostsResolutionStrategy resolutionStrategy)
ApiClient	setHttpClient(jakarta.ws.rs.client.Client httpClient)
ApiClient	setKeepAliveDuration(long keepAliveDuration) Set the connection keep alive duration.
ApiClient	setMaxConnections(int maxConnections) Set the maximum http pooled connections to endpoint.
ApiClient	setMaxRequestRetries(int numRetries)
void	setPassword(String password) Helper method to set password for the first HTTP basic authentication.
ApiClient	setRequestRetryInterval(int milliseconds)
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).
void	setUsername(String username) Helper method to set username for the first HTTP basic authentication.
void	shutdownExecutor(ExecutorService executor)

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

getJSON

public JSON getJSON()

Gets the JSON instance to do JSON serialization and deserialization.

Returns:

JSON

getHttpClient

public jakarta.ws.rs.client.Client getHttpClient()

setHttpClient

public ApiClient setHttpClient(jakarta.ws.rs.client.Client httpClient)

getBasePath

public String getBasePath()

setBasePath

public ApiClient setBasePath(String basePath)

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 object

getAuthentication

public Authentication getAuthentication(String authName)

Get authentication for the given name.

Parameters:

authName - The authentication name

Returns:

The authentication, null if not found

setUsername

public void setUsername(String username)

Helper method to set username for the first HTTP basic authentication.

Parameters:

username - Username

setPassword

public void setPassword(String password)

Helper method to set password for the first HTTP basic authentication.

Parameters:

password - Password

setBasicAuthString

public void setBasicAuthString(String authString)

Helper method to set username:password pair for the first HTTP basic authentication.

Parameters:

authString - Base-64 encoding of username:password

setApiKey

public void setApiKey(String apiKey)

Helper method to set API key value for the first API key authentication.

Parameters:

apiKey - API key

setApiKeyPrefix

public void setApiKeyPrefix(String apiKeyPrefix)

Helper method to set API key prefix for the first API key authentication.

Parameters:

apiKeyPrefix - API key prefix

setAccessToken

public void setAccessToken(String accessToken)

Helper method to set access token for the first OAuth2 authentication.

Parameters:

accessToken - Access token

setUserAgent

public ApiClient setUserAgent(String userAgent)

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

Parameters:

userAgent - Http user agent

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

isDebugging

public boolean isDebugging()

Check that whether debugging is enabled for this API client.

Returns:

True if debugging is switched 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

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:

Temp folder path

setTempFolderPath

public ApiClient setTempFolderPath(String tempFolderPath)

Set temp folder path

Parameters:

tempFolderPath - Temp folder path

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

getKeepAliveDuration

public long getKeepAliveDuration()

Custom connection keep alive duration in milliseconds. This is applicable only if maxConnections is set.

Returns:

Maximum connections

setKeepAliveDuration

public ApiClient setKeepAliveDuration(long keepAliveDuration)

Set the connection keep alive duration. If remote host doesn't set keep-alive header in the response, then this value is used to keep idle connections to keep alive.

Parameters:

keepAliveDuration - Keep-alive duration in millisecons

Returns:

API client

getMaxConnections

public int getMaxConnections()

Maximum http pooled connections to endpoint.

Returns:

Maximum connections

setMaxConnections

public ApiClient setMaxConnections(int maxConnections)

Set the maximum http pooled connections to endpoint.

Parameters:

maxConnections - Maximum http pooled connections

Returns:

API client

setRequestRetryInterval

public ApiClient setRequestRetryInterval(int milliseconds)

setMaxRequestRetries

public ApiClient setMaxRequestRetries(int numRetries)

setClientSideFailoverEnabled

public ApiClient setClientSideFailoverEnabled(boolean isEnabled)

setHostsResolutionStrategy

public ApiClient setHostsResolutionStrategy(HostsResolutionStrategy resolutionStrategy)

setEndpointHealthCheckInterval

public ApiClient setEndpointHealthCheckInterval(int milliseconds)

getConnectionStats

public org.apache.http.pool.PoolStats getConnectionStats()

Get the connection pool statistics, only if maxConnections is set. This include number of Leased, Pending, Available and Maximum connections to all routes. If maxConnections is not set, then returns null.

Returns:

String message containing connection pool statistics

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

parameterToPairs

public List<Pair> parameterToPairs(String collectionFormat,
                                   String name,
                                   Object value)

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 the MIME type is JSON

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, 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

serialize

public jakarta.ws.rs.client.Entity<?> serialize(Object obj,
                                                Map<String,Object> formParams,
                                                String contentType)
                                         throws ApiException

Serialize the given Java object into string entity according the given Content-Type (only JSON is supported for now).

Parameters:

obj - Object

formParams - Form parameters

contentType - Context type

Returns:

Entity

Throws:

ApiException - API exception

deserialize

public <T> T deserialize(jakarta.ws.rs.core.Response response,
                         jakarta.ws.rs.core.GenericType<T> returnType)
                  throws ApiException

Deserialize response body to Java object according to the Content-Type.

Type Parameters:

T - Type

Parameters:

response - Response

returnType - Return type

Returns:

Deserialize object

Throws:

ApiException - API exception

downloadFileFromResponse

public File downloadFileFromResponse(jakarta.ws.rs.core.Response response)
                              throws ApiException

Download file from the given response.

Parameters:

response - Response

Returns:

File

Throws:

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

prepareDownloadFile

public File prepareDownloadFile(jakarta.ws.rs.core.Response response)
                         throws IOException

Throws:

IOException

invokeAPIWithEndpoint

public com.fortanix.sdkms.v1.ApiClient.ResponseWithMetadata invokeAPIWithEndpoint(String endpoint,
                                                                                  String path,
                                                                                  jakarta.ws.rs.client.Entity entity,
                                                                                  String method,
                                                                                  List<Pair> queryParams,
                                                                                  Object body,
                                                                                  Map<String,String> headerParams,
                                                                                  Map<String,Object> formParams,
                                                                                  String accept,
                                                                                  String contentType,
                                                                                  String[] authNames)

Invoke API by sending HTTP request to a given endpoint with the given options.

Parameters:

endpoint - The endpoint to which the request has to be made.

path - The sub-path of the HTTP URL

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

queryParams - The query parameters

body - The request body object

headerParams - The header parameters

formParams - The form parameters

accept - The request's Accept header

contentType - The request's Content-Type header

authNames - The authentications to apply

Returns:

The closable HTTP response.

processResponse

public <T> T processResponse(com.fortanix.sdkms.v1.ApiClient.ResponseWithMetadata responseWithMetadata,
                             jakarta.ws.rs.core.GenericType<T> returnType)

Deserialize the HTTP response to the provided type, also closes the HTTP response at the end of the function

Type Parameters:

T - Type

Parameters:

responseWithMetadata - The data structure that contains the HTTP response along with some other metadata essential for logging

returnType - The return type into which to deserialize the response

Returns:

The deserialized response object of type T.

invokeAPI

public <T> T invokeAPI(String path,
                       String method,
                       List<Pair> queryParams,
                       Object body,
                       Map<String,String> headerParams,
                       Map<String,Object> formParams,
                       String accept,
                       String contentType,
                       String[] authNames,
                       jakarta.ws.rs.core.GenericType<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

body - The request body object

headerParams - The header parameters

formParams - The form parameters

accept - The request's Accept header

contentType - The request's Content-Type header

authNames - The authentications to apply

returnType - The return type into which to deserialize the response

Returns:

The response body in type of string

Throws:

ApiException - API exception

shutdownExecutor

public void shutdownExecutor(ExecutorService executor)

graceFullShutdown

public void graceFullShutdown()