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(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.http.api.domain.message.request.HttpRequestBuilder	requestBuilder(String baseUri, String path, org.mule.runtime.http.api.HttpConstants.Method method, org.mule.runtime.api.metadata.TypedValue<InputStream> body, RequestParameters parameters) Creates a preconfigured HttpRequestBuilder per the given parameters.

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(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:

connection - the connection to use

builder - the request builder

responseTimeoutMillis - the request timeout in millis

streamingHelper - the StreamingHelper

callback - the operation's CompletionCallback

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

requestBuilder

protected org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder(String baseUri,
                                                                                             String path,
                                                                                             org.mule.runtime.http.api.HttpConstants.Method method,
                                                                                             org.mule.runtime.api.metadata.TypedValue<InputStream> body,
                                                                                             RequestParameters parameters)

Creates a preconfigured HttpRequestBuilder per the given parameters.

This method automatically merges and configures query params and headers per the config's default and the operation's specific parameters. It also handles the TRANSFER_ENCODING and CONTENT-LENGTH parameters based on the provided headers and body.

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

body - a nullable TypedValue to be sent as the request entity

parameters - the request parameters

Returns:

a new HttpRequestBuilder