com.siemens.mindsphere.sdk.core

Class ApiInvoker

Object

ApiInvoker

public class ApiInvoker
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiInvoker.CollectionFormat

Constructor Summary

Constructors

Constructor and Description
ApiInvoker() Constructs a new empty ApiInvoker instance

Method Summary

Modifier and Type	Method and Description
ApiInvoker	addDefaultHeader(String name, String value) Add a default header.
protected void	addHeadersToRequest(HttpHeaders headers, RequestEntity.BodyBuilder requestBuilder) Add headers to the request that is being built
String	formatDate(Date date) Format the given Date object into string.
DateFormat	getDateFormat() Get the date format used to parse/format date parameters.
MultiValueMap<String,String>	getResponseHeaders() Gets the response headers of the previous request
HttpStatus	getStatusCode() Gets the status code of the previous request
<T> T	invokeAPI(InvokerConfig config, String path, HttpMethod method, MultiValueMap<String,String> queryParams, Object body, HttpHeaders headerParams, MultiValueMap<String,Object> formParams, List<MediaType> accept, MediaType contentType, ParameterizedTypeReference<T> returnType) Invokes API service end point with supplied parameters.
boolean	isJsonMime(MediaType mediaType) Check if the given MIME is a JSON MIME.
boolean	isJsonMime(String mediaType) Check if the given String is a JSON MIME.
MultiValueMap<String,String>	parameterToMultiValueMap(ApiInvoker.CollectionFormat collectionFormat, String name, Object value) Converts a parameter to a MultiValueMap for use in REST requests
String	parameterToString(Object param) Converts different types of parameters to string
Date	parseDate(String dateString) Converts date string to date objects
protected Object	selectBody(Object obj, MultiValueMap<String,Object> formParams, MediaType contentType) Select the body to use for the request
List<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)
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.
ApiInvoker	setDateFormat(DateFormat dateFormat) Set the date format used to parse/format date parameters.

Methods inherited from class Object

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

Constructor Detail

ApiInvoker

public ApiInvoker()

Constructs a new empty ApiInvoker instance

Method Detail

getStatusCode

public HttpStatus getStatusCode()

Gets the status code of the previous request

Returns:

HttpStatus the status code

getResponseHeaders

public MultiValueMap<String,String> getResponseHeaders()

Gets the response headers of the previous request

Returns:

MultiValueMap a map of response headers

addDefaultHeader

public ApiInvoker addDefaultHeader(String name,
                                   String value)

Add a default header.

Parameters:

name - The header's name

value - The header's value

Returns:

ApiInvoker this client

getDateFormat

public DateFormat getDateFormat()

Get the date format used to parse/format date parameters.

Returns:

DateFormat format

setDateFormat

public ApiInvoker 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 dateString)
               throws MindsphereException

Converts date string to date objects

Parameters:

dateString - String representation of date

Returns:

Date string

Throws:

MindsphereException - thrown if an exception is encountered during conversion

formatDate

public String formatDate(Date date)

Format the given Date object into string.

Parameters:

date - The date object to be converted to string

Returns:

Date string

parameterToString

public String parameterToString(Object param)

Converts different types of parameters to string

Parameters:

param - Parameter as an object instance

Returns:

String representation of the parameter

parameterToMultiValueMap

public MultiValueMap<String,String> parameterToMultiValueMap(ApiInvoker.CollectionFormat collectionFormat,
                                                             String name,
                                                             Object value)

Converts a parameter to a MultiValueMap for use in REST requests

Parameters:

collectionFormat - The format to convert to

name - The name of the parameter

value - 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 given String is a JSON MIME.

Parameters:

mediaType - the input MediaType

Returns:

boolean true if the MediaType represents JSON, false otherwise

isJsonMime

public boolean isJsonMime(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<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 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,
                            MultiValueMap<String,Object> formParams,
                            MediaType contentType)

Select the body to use for the request

Parameters:

obj - the body object

formParams - the form parameters

contentType - the content type of the request

Returns:

Object the selected body

invokeAPI

public <T> T invokeAPI(InvokerConfig config,
                       String path,
                       HttpMethod method,
                       MultiValueMap<String,String> queryParams,
                       Object body,
                       HttpHeaders headerParams,
                       MultiValueMap<String,Object> formParams,
                       List<MediaType> accept,
                       MediaType contentType,
                       ParameterizedTypeReference<T> returnType)
                throws MindsphereException

Invokes API service end point with supplied parameters.

Parameters:

config - InvokerConfig instance

path - Base path of service end point

method - Http method to be used

queryParams - Query parameters supplied for the service end point call

body - Request body contents

headerParams - Header parameters supplied for the service end point call

formParams - Form parameters supplied for the service end point call

accept - Media Types accepted

contentType - Content type of the request

returnType - Response Type expected

Returns:

T<T> Response type instance

Throws:

MindsphereException - thrown if an error occurs while attempting to invoke the API

addHeadersToRequest

protected void addHeadersToRequest(HttpHeaders headers,
                                   RequestEntity.BodyBuilder requestBuilder)

Add headers to the request that is being built

Parameters:

headers - The headers to add

requestBuilder - The current request