com.mulesoft.connectivity.rest.commons.api.connection

Class DefaultRestConnection

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.connection.BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

com.mulesoft.connectivity.rest.commons.api.connection.DefaultRestConnection

All Implemented Interfaces:

RestConnection

Direct Known Subclasses:

BearerRestConnection, OAuthRestConnection

public class DefaultRestConnection
extends BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

Implementation that handles RESTfull responses and handling errors based on RestError.

Constructor Summary

Constructors

Constructor and Description
DefaultRestConnection(org.mule.runtime.http.api.client.HttpClient httpClient, org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions, String baseUri, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)

Method Summary

Modifier and Type	Method and Description
protected org.mule.runtime.extension.api.exception.ModuleException	createModuleException(org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse, org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError> errorTypeDefinition, org.mule.runtime.api.metadata.MediaType defaultMediaType) Utility method that provides a hook for customizing the E to be thrown when an HttpResponse is marked as failure based on BaseRestConnection.httpResponseToErrorTypeDefinition(HttpResponse, MediaType).
protected Optional<org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>	httpResponseToErrorTypeDefinition(org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse, org.mule.runtime.api.metadata.MediaType mediaType) Template method that allows usage of custom ErrorTypeDefinition's for those scenarios where SaaS is not Restful complaint or signal success error responses are returned with 20x responses.
protected org.mule.runtime.http.api.domain.entity.HttpEntity	materializeHttpResponseEntity(org.mule.runtime.http.api.domain.entity.HttpEntity httpEntity) Whenever the connection implementation needs to handle signal error responses which are 200 response status code the method BaseRestConnection.httpResponseToErrorTypeDefinition(HttpResponse, MediaType) would be implemented in order to read the entity content response to check for the signal error flag.
protected org.mule.runtime.extension.api.exception.ModuleException	toConnectivityErrorFunction(Throwable throwable) Template method that allows usage of custom ErrorTypeDefinition's for general errors like TimeoutException or IOException which are thrown by the HttpClient API.

Methods inherited from class com.mulesoft.connectivity.rest.commons.api.connection.BaseRestConnection

authenticate, beforeRequest, getBaseUri, getCommonsExpressionLanguage, getExpressionLanguage, getHttpClient, getHttpRequestOptions, getMediaType, send, sendAsync, throwModuleExceptionIfErrorResponse, toResult, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRestConnection

public DefaultRestConnection(org.mule.runtime.http.api.client.HttpClient httpClient,
                             org.mule.runtime.http.api.client.HttpRequestOptions httpRequestOptions,
                             String baseUri,
                             org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)

Method Detail

materializeHttpResponseEntity

protected org.mule.runtime.http.api.domain.entity.HttpEntity materializeHttpResponseEntity(org.mule.runtime.http.api.domain.entity.HttpEntity httpEntity)

Description copied from class: BaseRestConnection

Whenever the connection implementation needs to handle signal error responses which are 200 response status code the method BaseRestConnection.httpResponseToErrorTypeDefinition(HttpResponse, MediaType) would be implemented in order to read the entity content response to check for the signal error flag. If this is done without materializing the HttpEntity it won't later allow the client which made the request to be executed by the connection to consume the response. Therefore, this method allows to materialize the entity so it would allow to be read more than once.

Specified by:

materializeHttpResponseEntity in class BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

Parameters:

httpEntity - the server's response.

Returns:

an HttpEntity that allows to be read more than once.

httpResponseToErrorTypeDefinition

protected Optional<org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>> httpResponseToErrorTypeDefinition(org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse,
                                                                                                                          org.mule.runtime.api.metadata.MediaType mediaType)

Description copied from class: BaseRestConnection

Template method that allows usage of custom ErrorTypeDefinition's for those scenarios where SaaS is not Restful complaint or signal success error responses are returned with 20x responses. By overriding this method in a custom connection implementation allows customizing ErrorTypeDefinition's. If the function returns an Optional.empty() it means the HttpResponse is a success. If this method is overridden most like BaseRestConnection.toConnectivityErrorFunction(Throwable) would need to be too as it uses RestError for generic errors.
For scenarios like signal error responses with success status code responses it is recommended to materialize the HttpResponse entity content with an in memory implementation such is ByteArrayHttpEntity by overwritten BaseRestConnection.materializeHttpResponseEntity(HttpEntity) so it could be consumed more than once, to check the body content for signal error and if it not an error by the client when processing the response.

Specified by:

httpResponseToErrorTypeDefinition in class BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

Parameters:

httpResponse - the response HttpResponse from the server.

mediaType - to read the entity content from server.

Returns:

a Optional to check if the response corresponds to an error.

createModuleException

protected org.mule.runtime.extension.api.exception.ModuleException createModuleException(org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse,
                                                                                         org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError> errorTypeDefinition,
                                                                                         org.mule.runtime.api.metadata.MediaType defaultMediaType)

Description copied from class: BaseRestConnection

Utility method that provides a hook for customizing the E to be thrown when an HttpResponse is marked as failure based on BaseRestConnection.httpResponseToErrorTypeDefinition(HttpResponse, MediaType).
Default implementation will generate an error.description based on statusCode " " reasonPhrase.
It is recommended to write in the connector's base code a specific E that also implements ErrorMessageAwareException so it associates the HttpResponse body as payload and the attributes representation's for the response.

Specified by:

createModuleException in class BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

Parameters:

httpResponse - the response HttpResponse from the server.

errorTypeDefinition - ErrorTypeDefinition associated to this failure response.

defaultMediaType - to read the entity content from server.

Returns:

a E with the description and the ErrorTypeDefinition associated.

toConnectivityErrorFunction

protected org.mule.runtime.extension.api.exception.ModuleException toConnectivityErrorFunction(Throwable throwable)

Description copied from class: BaseRestConnection

Template method that allows usage of custom ErrorTypeDefinition's for general errors like TimeoutException or IOException which are thrown by the HttpClient API. The implementation should consider that a E may be passed to this function in which case it should be propagated as it is. By overriding this method in a custom connection implementation it will allow customizing these ErrorTypeDefinition's.

Specified by:

toConnectivityErrorFunction in class BaseRestConnection<org.mule.runtime.extension.api.exception.ModuleException,org.mule.runtime.extension.api.error.ErrorTypeDefinition<RestError>>

Returns:

a Function to handle a Throwable and return a E with its corresponding ErrorTypeDefinition.