org.mule.connectors.restconnect.commons.api.operation

Class BaseRestConnectOperation

java.lang.Object

org.mule.connectors.restconnect.commons.api.operation.BaseRestConnectOperation

public abstract class BaseRestConnectOperation
extends Object

Base class for operations that consume a remote REST endpoint

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
BaseRestConnectOperation()

Method Summary

Modifier and Type	Method and Description
protected void	doRequest(RestConnectConfiguration config, RestConnection connection, org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder, int responseTimeoutMillis, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, 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, org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder, int responseTimeoutMillis, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, org.mule.runtime.extension.api.runtime.process.CompletionCallback<String,HttpResponseAttributes> 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.http.api.domain.message.request.HttpRequestBuilder	requestBuilder(String baseUri, String path, org.mule.runtime.http.api.HttpConstants.Method method, RequestParameters parameters) Creates a preconfigured HttpRequestBuilder per the given parameters.
protected org.mule.runtime.api.metadata.MediaType	resolveDefaultResponseMediaType(RestConnectConfiguration config)
protected void	setBody(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder, org.mule.runtime.api.metadata.TypedValue<InputStream> body) Sets the request body, and media-type and content-length headers from it if those are not already defined.
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

BaseRestConnectOperation

public BaseRestConnectOperation()

Method Detail

doRequest

protected void doRequest(RestConnectConfiguration config,
                         RestConnection connection,
                         org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder,
                         int responseTimeoutMillis,
                         org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper,
                         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

streamingHelper - the StreamingHelper

callback - the operation's CompletionCallback

resolveDefaultResponseMediaType

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

doVoidRequest

protected void doVoidRequest(RestConnection connection,
                             org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder,
                             int responseTimeoutMillis,
                             org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper,
                             org.mule.runtime.extension.api.runtime.process.CompletionCallback<String,HttpResponseAttributes> 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

streamingHelper - the StreamingHelper

callback - the operation's CompletionCallback

setBody

protected void setBody(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder,
                       org.mule.runtime.api.metadata.TypedValue<InputStream> body)

Sets the request body, and media-type and content-length headers from it if those are not already defined. This method should be called after all the other parameters for the request have already been set.

Parameters:

builder - the request builder

body - the request body (nullable)

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

requestBuilder

protected org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder(String baseUri,
                                                                                             String path,
                                                                                             org.mule.runtime.http.api.HttpConstants.Method method,
                                                                                             RequestParameters parameters)

Creates a preconfigured HttpRequestBuilder per the given parameters.

This creates a new HttpRequestBuilder and initializes it's URI, method, custom query params and custom headers.

The returned builder can still to add/change additional information.

Parameters:

baseUri - the base uri to be used

path - the path of the resource to request, relative to the base URI

method - the request method

parameters - the request parameters

Returns:

a new HttpRequestBuilder

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