com.amazon.ask.model.services

Class BaseServiceClient

java.lang.Object

com.amazon.ask.model.services.BaseServiceClient

Direct Known Subclasses:

LwaClient

public abstract class BaseServiceClient
extends Object

Class to be used as the base class for the generated service clients.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiClient	apiClient
protected String	apiEndpoint
protected String	authorizationValue
protected Serializer	serializer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseServiceClient(ApiConfiguration apiConfiguration)

Method Summary

Modifier and Type	Method and Description
protected <T> ApiResponse<T>	executeRequest(String method, String endpoint, String path, List<Pair<String,String>> queryParams, List<Pair<String,String>> headerParams, Map<String,String> pathParams, List<ServiceClientResponse> responseDefinitions, Object body, Class<T> responseType, boolean rawRequest) Calls the ApiClient based on the ServiceClient specific data provided as well as handles the well-known responses from the Api
protected Object	invoke(String method, String endpoint, String path, List<Pair<String,String>> queryParams, List<Pair<String,String>> headerParams, Map<String,String> pathParams, List<ServiceClientResponse> responseDefinitions, Object body, Class responseType) Deprecated.
protected Object	invoke(String method, String endpoint, String path, List<Pair<String,String>> queryParams, List<Pair<String,String>> headerParams, Map<String,String> pathParams, List<ServiceClientResponse> responseDefinitions, Object body, Class responseType, boolean rawRequest) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

apiClient

protected ApiClient apiClient

serializer

protected Serializer serializer

authorizationValue

protected String authorizationValue

apiEndpoint

protected String apiEndpoint

Constructor Detail

BaseServiceClient

protected BaseServiceClient(ApiConfiguration apiConfiguration)

Method Detail

invoke

@Deprecated
protected Object invoke(String method,
                                    String endpoint,
                                    String path,
                                    List<Pair<String,String>> queryParams,
                                    List<Pair<String,String>> headerParams,
                                    Map<String,String> pathParams,
                                    List<ServiceClientResponse> responseDefinitions,
                                    Object body,
                                    Class responseType)
                             throws ServiceException

Deprecated.

Calls the ApiClient based on the ServiceClient specific data provided as well as handles the well-known responses from the Api

Parameters:

method - Http Method

endpoint - Base Endpoint to make the request to

path - Specific path to hit. It might contain variables to be interpolated with pathParams.

queryParams - Parameter values to be sent as part of the query string

headerParams - Parameter values to be sent as headers

pathParams - Parameter values to be interpolated in the path

responseDefinitions - Well-known expected responses by the ServiceClient

body - Request body

responseType - Type of the expected Response if applicable

Returns:

Response object instance of the responseType provided

Throws:

ServiceException - Thrown when a failure happens or when getting an Error Response from the Api.

invoke

@Deprecated
protected Object invoke(String method,
                                    String endpoint,
                                    String path,
                                    List<Pair<String,String>> queryParams,
                                    List<Pair<String,String>> headerParams,
                                    Map<String,String> pathParams,
                                    List<ServiceClientResponse> responseDefinitions,
                                    Object body,
                                    Class responseType,
                                    boolean rawRequest)
                             throws ServiceException

Deprecated.

Calls the ApiClient based on the ServiceClient specific data provided as well as handles the well-known responses from the Api

Parameters:

method - Http Method

endpoint - Base Endpoint to make the request to

path - Specific path to hit. It might contain variables to be interpolated with pathParams.

queryParams - Parameter values to be sent as part of the query string

headerParams - Parameter values to be sent as headers

pathParams - Parameter values to be interpolated in the path

responseDefinitions - Well-known expected responses by the ServiceClient

body - Request body

responseType - Type of the expected Response if applicable

Returns:

Response object instance of the responseType provided

Throws:

ServiceException - Thrown when a failure happens or when getting an Error Response from the Api.

executeRequest

protected <T> ApiResponse<T> executeRequest(String method,
                                            String endpoint,
                                            String path,
                                            List<Pair<String,String>> queryParams,
                                            List<Pair<String,String>> headerParams,
                                            Map<String,String> pathParams,
                                            List<ServiceClientResponse> responseDefinitions,
                                            Object body,
                                            Class<T> responseType,
                                            boolean rawRequest)
                                     throws ServiceException

Calls the ApiClient based on the ServiceClient specific data provided as well as handles the well-known responses from the Api

Parameters:

method - Http Method

endpoint - Base Endpoint to make the request to

path - Specific path to hit. It might contain variables to be interpolated with pathParams.

queryParams - Parameter values to be sent as part of the query string

headerParams - Parameter values to be sent as headers

pathParams - Parameter values to be interpolated in the path

responseDefinitions - Well-known expected responses by the ServiceClient

body - Request body

responseType - Type of the expected Response if applicable

Returns:

ApiResponse containing a Response object instance of the responseType provided

Throws:

ServiceException - Thrown when a failure happens or when getting an Error Response from the Api.