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

Constructor Summary

Constructors

Constructor and Description
BaseRestOperation()

Method Summary

Modifier and Type	Method and Description
protected CommonsExpressionLanguage	getCommonsExpressionLanguage() Simplified, and limited, version of the runtime's expression language, which heavily relies on CommonsBindingContext.
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 <P,A,T> Function<Throwable,T>	notifyCompletionCallbackError(org.mule.runtime.extension.api.runtime.process.CompletionCallback<P,A> completionCallback) Utility method that provides a Function responsible for handling Throwables and notify the CompletionCallback on non-blocking operations only.
protected org.mule.runtime.api.metadata.MediaType	resolveDefaultResponseMediaType(RestConfiguration config) Resolves the default MediaType to be used when processing the response if remote server doesn't specify a Content-Type header.
protected void	setExpressionLanguage(org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)
protected org.mule.runtime.extension.api.exception.ModuleException	toUnknownErrorModuleException(Throwable throwable) Allows to customize the generation of a ModuleException for unknown errors.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRestOperation

public BaseRestOperation()

Method Detail

getExpressionLanguage

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

setExpressionLanguage

protected void setExpressionLanguage(org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)

getCommonsExpressionLanguage

protected CommonsExpressionLanguage getCommonsExpressionLanguage()

Simplified, and limited, version of the runtime's expression language, which heavily relies on CommonsBindingContext.
Example below:

 CommonsBindingContext.Builder builder = CommonsBindingContext.builder();
 String json = "{\"name\":\"John\", \"age\":30, \"car\":null}";
 InputStream value = new ByteArrayInputStream(json.getBytes(StandardCharsets.UTF_8));
 builder.addJson("jsonBinding", value, StandardCharsets.UTF_8);
 CommonsExpressionLanguageValue evaluatedExpression =
     commonsExpressionLanguage.evaluateJson("jsonBinding - 'car'", builder.build());
 

leaving in evaluatedExpression a CommonsExpressionLanguageValue object with the following String value:

   {"name":"John", "age":30}
 

Returns:

a CommonsExpressionLanguage to evaluate expressions with.

notifyCompletionCallbackError

protected final <P,A,T> Function<Throwable,T> notifyCompletionCallbackError(org.mule.runtime.extension.api.runtime.process.CompletionCallback<P,A> completionCallback)

Utility method that provides a Function responsible for handling Throwables and notify the CompletionCallback on non-blocking operations only. It will unwrap a CompletionException to get the root cause.
Example of usage in a non-blocking operation:

 connection.sendAsync(HttpRequest.builder()
     .uri(connection.getBaseUri() + "/accounts/" + accountId)
     .build())
     .thenAccept(httpResponse -> completionCallback.success(Result.builder()
         .output(IOUtils.toString(httpResponse.getEntity().getContent()))
         .attributes(httpResponse.getStatusCode())
         .attributesMediaType(APPLICATION_JAVA)
         .build()))
     .exceptionally(notifyCompletionCallbackError(completionCallback));
 

Type Parameters:

P - type for output.

A - type for output attributes.

Parameters:

completionCallback - the CompletionCallback to be notified about the error.

Returns:

a Function to be provided as CompletableFuture.exceptionally(Function) to handle any Throwable that happens during the execution of the completable future. It is responsible for notifying the CompletionCallback with the Throwable.

toUnknownErrorModuleException

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

Allows to customize the generation of a ModuleException for unknown errors.

Parameters:

throwable - Throwable given an unexpected error it should create a ModuleException with a generic error like RestError.CONNECTIVITY.

Returns:

creates a ModuleException with a generic error like RestError.CONNECTIVITY.

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

resolveDefaultResponseMediaType

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

Resolves the default MediaType to be used when processing the response if remote server doesn't specify a Content-Type header.

Parameters:

config - RestConfiguration to get the defaultCharset from Mule Runtime.

Returns:

the MediaType.