com.mulesoft.connectivity.rest.commons.api.operation

Class BaseRestOperation

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation

public abstract class BaseRestOperation
extends Object

Base class for operations that consume a remote REST endpoint

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
BaseRestOperation() Default constructor used by Mule/SDK to instantiate this operation.
BaseRestOperation(org.mule.runtime.api.el.ExpressionLanguage expressionLanguage) Constructor to allow creating an operation without using IoC from Mule/SDK.

Method Summary

Modifier and Type	Method and Description
protected <T> org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,HttpResponseAttributes>	callbackObjectAttributesAdapter(org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,Object> callback)
protected void	doRequest(RestConfiguration config, RestConnection connection, RestRequestBuilder builder, int responseTimeoutMillis, Map<String,Object> parameterBindings, Map<String,Object> customParameterBindings, org.mule.runtime.extension.api.runtime.process.CompletionCallback<InputStream,HttpResponseAttributes> callback) Performs the request using the given builder and connection and completes the callback accordingly.
protected void	doVoidRequest(RestConnection connection, RestRequestBuilder builder, int responseTimeoutMillis, org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback) Performs the request using the given builder and connection and completes the callback accordingly, expecting the response to not contain a body.
protected org.mule.runtime.api.metadata.MediaType	getDefaultResponseMediaType() This method specifies the MediaType that should be assumed the response to have in case the remote service doesn't specify a Content-Type header.
protected org.mule.runtime.api.el.ExpressionLanguage	getExpressionLanguage()
protected HttpRequestBinding	getRequestBindings()
protected String	getRequestBodyMediaType()
protected RestRequestBuilder	getRequestBuilderWithBindings(String baseUri, String path, org.mule.runtime.http.api.HttpConstants.Method method, RequestParameters requestParameters, ConfigurationOverrides overrides, RestConnection connection, RestConfiguration config, Map<String,Object> parameterBindings, Map<String,Object> customParameterBindings)
protected HttpResponseBinding	getResponseBindings()
protected String	getResponseBodyMediaType()
protected HttpResponseInterceptorDescriptor	getResponseInterceptorDescriptor(RestConfiguration config) This method return the http response interceptor descriptor from the configuration.
protected <T> BiConsumer<org.mule.runtime.extension.api.runtime.operation.Result<T,HttpResponseAttributes>,Throwable>	handleResponse(org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,HttpResponseAttributes> callback, Map<String,Object> parameterBindings, Map<String,Object> customParameterBindings)
protected org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>	postProcessResult(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes> result, Map<String,Object> parameterBindings, Map<String,Object> customParameterBindings)
protected org.mule.runtime.api.metadata.MediaType	resolveDefaultResponseMediaType(RestConfiguration config)
protected <T> org.mule.runtime.extension.api.runtime.operation.Result<T,Object>	toObjectResult(org.mule.runtime.extension.api.runtime.operation.Result<? super T,HttpResponseAttributes> result)
protected <T,A> void	withMultipart(Consumer<MultipartPayloadBuilder> builderConfigurer, org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,A> callback, BiConsumer<org.mule.runtime.api.metadata.TypedValue<InputStream>,org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,A>> consumer) Allows to make a multipart request by facilitating the construction of the multipart body through a MultipartPayloadBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRestOperation

public BaseRestOperation()

Default constructor used by Mule/SDK to instantiate this operation.

BaseRestOperation

public BaseRestOperation(org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)

Constructor to allow creating an operation without using IoC from Mule/SDK. This is useful when reusing connector's operations.

Parameters:

expressionLanguage -

Method Detail

doRequest

protected void doRequest(RestConfiguration config,
                         RestConnection connection,
                         RestRequestBuilder builder,
                         int responseTimeoutMillis,
                         Map<String,Object> parameterBindings,
                         Map<String,Object> customParameterBindings,
                         org.mule.runtime.extension.api.runtime.process.CompletionCallback<InputStream,HttpResponseAttributes> callback)

Performs the request using the given builder and connection and completes the callback accordingly.

Parameters:

config - the operation's config

connection - the connection to use

builder - the request builder

responseTimeoutMillis - the request timeout in millis

callback - the operation's CompletionCallback

resolveDefaultResponseMediaType

protected org.mule.runtime.api.metadata.MediaType resolveDefaultResponseMediaType(RestConfiguration config)

doVoidRequest

protected void doVoidRequest(RestConnection connection,
                             RestRequestBuilder builder,
                             int responseTimeoutMillis,
                             org.mule.runtime.extension.api.runtime.process.CompletionCallback<Void,Void> callback)

Performs the request using the given builder and connection and completes the callback accordingly, expecting the response to not contain a body.

If successful, the callback will be completed with an empty String as payload.

Parameters:

connection - the connection to use

builder - the request builder

responseTimeoutMillis - the request timeout in millis

callback - the operation's CompletionCallback

handleResponse

protected <T> BiConsumer<org.mule.runtime.extension.api.runtime.operation.Result<T,HttpResponseAttributes>,Throwable> handleResponse(org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,HttpResponseAttributes> callback,
                                                                                                                                     Map<String,Object> parameterBindings,
                                                                                                                                     Map<String,Object> customParameterBindings)

withMultipart

protected <T,A> void withMultipart(Consumer<MultipartPayloadBuilder> builderConfigurer,
                                   org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,A> callback,
                                   BiConsumer<org.mule.runtime.api.metadata.TypedValue<InputStream>,org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,A>> consumer)

Allows to make a multipart request by facilitating the construction of the multipart body through a MultipartPayloadBuilder.

This operation MUST NOT be completed using the callback passed as a parameter, but the one provided through the consumer

Type Parameters:

T - the generic type of the callback payload type

A - the generic type of the callback attributes type

Parameters:

builderConfigurer - a Consumer which gives access to the MultipartPayloadBuilder and allows to configure it

callback - the operation's CompletionCallback

consumer - the Consumer which gives access to the built multipart body and the effective callback that should complete this operation

getDefaultResponseMediaType

protected org.mule.runtime.api.metadata.MediaType getDefaultResponseMediaType()

This method specifies the MediaType that should be assumed the response to have in case the remote service doesn't specify a Content-Type header.

By default, this method returns MediaType.APPLICATION_JSON since it's the most common response type. However, this method should be overwritten if a different type of media type is to be expected, or if you know that a certain encoding will be enforced.

Returns:

the MediaType to assign the response in case the server doesn't specify one in its response

getExpressionLanguage

protected org.mule.runtime.api.el.ExpressionLanguage getExpressionLanguage()

getRequestBuilderWithBindings

protected RestRequestBuilder getRequestBuilderWithBindings(String baseUri,
                                                           String path,
                                                           org.mule.runtime.http.api.HttpConstants.Method method,
                                                           RequestParameters requestParameters,
                                                           ConfigurationOverrides overrides,
                                                           RestConnection connection,
                                                           RestConfiguration config,
                                                           Map<String,Object> parameterBindings,
                                                           Map<String,Object> customParameterBindings)

getRequestBodyMediaType

protected String getRequestBodyMediaType()

getResponseBodyMediaType

protected String getResponseBodyMediaType()

getRequestBindings

protected HttpRequestBinding getRequestBindings()

getResponseBindings

protected HttpResponseBinding getResponseBindings()

postProcessResult

protected org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes> postProcessResult(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes> result,
                                                                                                                        Map<String,Object> parameterBindings,
                                                                                                                        Map<String,Object> customParameterBindings)

callbackObjectAttributesAdapter

protected <T> org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,HttpResponseAttributes> callbackObjectAttributesAdapter(org.mule.runtime.extension.api.runtime.process.CompletionCallback<T,Object> callback)

toObjectResult

protected <T> org.mule.runtime.extension.api.runtime.operation.Result<T,Object> toObjectResult(org.mule.runtime.extension.api.runtime.operation.Result<? super T,HttpResponseAttributes> result)

getResponseInterceptorDescriptor

protected HttpResponseInterceptorDescriptor getResponseInterceptorDescriptor(RestConfiguration config)

This method return the http response interceptor descriptor from the configuration. If needed, this method could be overridden to specify individual interceptor descriptor for this operation.

Parameters:

config - rest configuration to get the default interceptors

Returns:

the http response interceptor descriptor to be added to the request builder