us.abstracta.jmeter.javadsl.engines

Class BaseRemoteEngineApiClient

java.lang.Object

us.abstracta.jmeter.javadsl.engines.BaseRemoteEngineApiClient

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class BaseRemoteEngineApiClient
extends Object
implements Closeable

Contains common logic used to interact with a remote engine service.

Since:

1.10

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseRemoteEngineApiClient(org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method and Description
protected <T> T	buildApiFor(String baseUrl, Class<T> apiClass) Allows to easily build a retrofit API annotated class instance for the given base URL and API class.
protected abstract String	buildAuthorizationHeaderValue(okhttp3.Request request) Builds the value to be contained in Authorization header included in http requests.
protected com.fasterxml.jackson.databind.ObjectMapper	buildConverterMapper() Configures a Jackson ObjectMapper to be used by retrofit to serialized and deserialize requests and responses for the API.
protected RemoteEngineException	buildRemoteEngineException(int code, String message) Builds a RemoteEngineException for a given status code and message.
void	close()
protected void	configureHttpClient(okhttp3.OkHttpClient.Builder builder)
protected <T> T	execApiCall(retrofit2.Call<T> call) Executes the given retrofit call, throwing an exception if the response code is not a successful one, or returning the call response otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRemoteEngineApiClient

protected BaseRemoteEngineApiClient(org.slf4j.Logger logger)

Method Detail

configureHttpClient

protected void configureHttpClient(okhttp3.OkHttpClient.Builder builder)

buildAuthorizationHeaderValue

protected abstract String buildAuthorizationHeaderValue(okhttp3.Request request)
                                                 throws IOException

Builds the value to be contained in Authorization header included in http requests.

Parameters:

request - contains information about the request which may be helpful to define the proper authorization value to be used.

Returns:

the value to be used in Authorization header. null if no Authorization header should be included in the request.

Throws:

IOException - if there is some problem contacting remote engine service (e.g.: when refreshing a token).

buildApiFor

protected <T> T buildApiFor(String baseUrl,
                            Class<T> apiClass)

Allows to easily build a retrofit API annotated class instance for the given base URL and API class.

Type Parameters:

T - specifies the type for the class that contains all the API annotated methods.

Parameters:

baseUrl - specifies the base URL to be used for all API methods of the given class.

apiClass - specifies the class which contains all the API annotated methods.

Returns:

the API annotated class instance for interaction with the remote engine service.

buildConverterMapper

protected com.fasterxml.jackson.databind.ObjectMapper buildConverterMapper()

Configures a Jackson ObjectMapper to be used by retrofit to serialized and deserialize requests and responses for the API.

Any particular RemoteEngineApiClient can override this method to specify custom configuration of the ObjectMapper.

Returns:

the ObjectMapper to be used by retrofit.

execApiCall

protected <T> T execApiCall(retrofit2.Call<T> call)
                     throws IOException

Executes the given retrofit call, throwing an exception if the response code is not a successful one, or returning the call response otherwise.

Type Parameters:

T - specifies the response type to be returned by the method call API invocation.

Parameters:

call - specifies the API method call to execute.

Returns:

the API method call response.

Throws:

IOException - if the response status code is not a successful one, or there is some problem contacting the remote engine service.

buildRemoteEngineException

protected RemoteEngineException buildRemoteEngineException(int code,
                                                           String message)

Builds a RemoteEngineException for a given status code and message.

This method is provided for backwards compatibility purposes, allowing existing remote engine apis to keep throwing their custom exceptions.

Parameters:

code - the response status code that generated the exception.

message - the response body.

Returns:

the exception to be thrown for the given response status code.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable