Package org.appng.api.rest
Class ApiClient
- java.lang.Object
-
- org.appng.api.rest.ApiClient
-
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen", date="2022-07-11T10:59:30.443+02:00") @Component("org.appng.api.rest.ApiClient") public class ApiClient extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ApiClient.CollectionFormat
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiClient
addDefaultHeader(String name, String value)
Add a default header.protected void
addHeadersToRequest(org.springframework.http.HttpHeaders headers, org.springframework.http.RequestEntity.BodyBuilder requestBuilder)
Add headers to the request that is being builtprotected org.springframework.web.client.RestTemplate
buildRestTemplate()
Build the RestTemplate used to make HTTP requests.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()
Get the current base pathDateFormat
getDateFormat()
Get the date format used to parse/format date parameters.org.springframework.util.MultiValueMap<String,String>
getResponseHeaders()
Gets the response headers of the previous requestorg.springframework.http.HttpStatus
getStatusCode()
Gets the status code of the previous requestprotected void
init()
<T> T
invokeAPI(String path, org.springframework.http.HttpMethod method, org.springframework.util.MultiValueMap<String,String> queryParams, Object body, org.springframework.http.HttpHeaders headerParams, org.springframework.util.MultiValueMap<String,Object> formParams, List<org.springframework.http.MediaType> accept, org.springframework.http.MediaType contentType, String[] authNames, org.springframework.core.ParameterizedTypeReference<T> returnType)
Invoke API by sending HTTP request with the given options.boolean
isDebugging()
Check that whether debugging is enabled for this API client.boolean
isJsonMime(String mediaType)
Check if the givenString
is a JSON MIME.boolean
isJsonMime(org.springframework.http.MediaType mediaType)
Check if the given MIME is a JSON MIME.org.springframework.util.MultiValueMap<String,String>
parameterToMultiValueMap(ApiClient.CollectionFormat collectionFormat, String name, Object value)
Converts a parameter to aMultiValueMap
for use in REST requestsString
parameterToString(Object param)
Format the given parameter object into string.Date
parseDate(String str)
Parse the given string into Date object.protected Object
selectBody(Object obj, org.springframework.util.MultiValueMap<String,Object> formParams, org.springframework.http.MediaType contentType)
Select the body to use for the requestList<org.springframework.http.MediaType>
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)org.springframework.http.MediaType
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.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)
Set the base path, which should include the hostApiClient
setDateFormat(DateFormat dateFormat)
Set the date format used to parse/format date parameters.void
setDebugging(boolean debugging)
void
setPassword(String password)
Helper method to set password for the first HTTP basic authentication.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.
-
-
-
Method Detail
-
init
protected void init()
-
getBasePath
public String getBasePath()
Get the current base path- Returns:
- String the base path
-
setBasePath
public ApiClient setBasePath(String basePath)
Set the base path, which should include the host- Parameters:
basePath
- the base path- Returns:
- ApiClient this client
-
getStatusCode
public org.springframework.http.HttpStatus getStatusCode()
Gets the status code of the previous request- Returns:
- HttpStatus the status code
-
getResponseHeaders
public org.springframework.util.MultiValueMap<String,String> getResponseHeaders()
Gets the response headers of the previous request- Returns:
- MultiValueMap a map of response headers
-
getAuthentications
public Map<String,Authentication> getAuthentications()
Get authentications (key: authentication name, value: authentication).- Returns:
- Map the currently configured authentication types
-
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
- the username
-
setPassword
public void setPassword(String password)
Helper method to set password for the first HTTP basic authentication.- Parameters:
password
- the password
-
setApiKey
public void setApiKey(String apiKey)
Helper method to set API key value for the first API key authentication.- Parameters:
apiKey
- the API key
-
setApiKeyPrefix
public void setApiKeyPrefix(String apiKeyPrefix)
Helper method to set API key prefix for the first API key authentication.- Parameters:
apiKeyPrefix
- the API key prefix
-
setAccessToken
public void setAccessToken(String accessToken)
Helper method to set access token for the first OAuth2 authentication.- Parameters:
accessToken
- the access token
-
setUserAgent
public ApiClient setUserAgent(String userAgent)
Set the User-Agent header's value (by adding to the default header map).- Parameters:
userAgent
- the user agent string- Returns:
- ApiClient this client
-
addDefaultHeader
public ApiClient addDefaultHeader(String name, String value)
Add a default header.- Parameters:
name
- The header's namevalue
- The header's value- Returns:
- ApiClient this client
-
setDebugging
public void setDebugging(boolean debugging)
-
isDebugging
public boolean isDebugging()
Check that whether debugging is enabled for this API client.- Returns:
- boolean true if this client is enabled for debugging, false otherwise
-
getDateFormat
public DateFormat getDateFormat()
Get the date format used to parse/format date parameters.- Returns:
- DateFormat format
-
setDateFormat
public ApiClient setDateFormat(DateFormat dateFormat)
Set the date format used to parse/format date parameters.- Parameters:
dateFormat
- Date format- Returns:
- API client
-
parameterToString
public String parameterToString(Object param)
Format the given parameter object into string.- Parameters:
param
- the object to convert- Returns:
- String the parameter represented as a String
-
parameterToMultiValueMap
public org.springframework.util.MultiValueMap<String,String> parameterToMultiValueMap(ApiClient.CollectionFormat collectionFormat, String name, Object value)
Converts a parameter to aMultiValueMap
for use in REST requests- Parameters:
collectionFormat
- The format to convert toname
- The name of the parametervalue
- The parameter's value- Returns:
- a Map containing the String value(s) of the input parameter
-
isJsonMime
public boolean isJsonMime(String mediaType)
Check if the givenString
is a JSON MIME.- Parameters:
mediaType
- the input MediaType- Returns:
- boolean true if the MediaType represents JSON, false otherwise
-
isJsonMime
public boolean isJsonMime(org.springframework.http.MediaType mediaType)
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON- Parameters:
mediaType
- the input MediaType- Returns:
- boolean true if the MediaType represents JSON, false otherwise
-
selectHeaderAccept
public List<org.springframework.http.MediaType> 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:
- List The list of MediaTypes to use for the Accept header
-
selectHeaderContentType
public org.springframework.http.MediaType 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:
- MediaType The Content-Type header to use. If the given array is empty, JSON will be used.
-
selectBody
protected Object selectBody(Object obj, org.springframework.util.MultiValueMap<String,Object> formParams, org.springframework.http.MediaType contentType)
Select the body to use for the request- Parameters:
obj
- the body objectformParams
- the form parameterscontentType
- the content type of the request- Returns:
- Object the selected body
-
invokeAPI
public <T> T invokeAPI(String path, org.springframework.http.HttpMethod method, org.springframework.util.MultiValueMap<String,String> queryParams, Object body, org.springframework.http.HttpHeaders headerParams, org.springframework.util.MultiValueMap<String,Object> formParams, List<org.springframework.http.MediaType> accept, org.springframework.http.MediaType contentType, String[] authNames, org.springframework.core.ParameterizedTypeReference<T> returnType) throws org.springframework.web.client.RestClientException
Invoke API by sending HTTP request with the given options.- Type Parameters:
T
- the return type to use- Parameters:
path
- The sub-path of the HTTP URLmethod
- The request methodqueryParams
- The query parametersbody
- The request body objectheaderParams
- The header parametersformParams
- The form parametersaccept
- The request's Accept headercontentType
- The request's Content-Type headerauthNames
- The authentications to applyreturnType
- The return type into which to deserialize the response- Returns:
- The response body in chosen type
- Throws:
org.springframework.web.client.RestClientException
-
addHeadersToRequest
protected void addHeadersToRequest(org.springframework.http.HttpHeaders headers, org.springframework.http.RequestEntity.BodyBuilder requestBuilder)
Add headers to the request that is being built- Parameters:
headers
- The headers to addrequestBuilder
- The current request
-
buildRestTemplate
protected org.springframework.web.client.RestTemplate buildRestTemplate()
Build the RestTemplate used to make HTTP requests.- Returns:
- RestTemplate
-
-