com.mulesoft.connectivity.rest.commons.api.interception

Interface HttpResponseInterceptor

All Known Implementing Classes:

BaseExpressionHttpResponseInterceptor, CompositeHttpResponseInterceptor, ExpressionHttpResponseInterceptor, PreconditionHttpResponseInterceptorDelegate

public interface HttpResponseInterceptor

An interceptor to manipulate a server's HttpResponse before RSDK processes it and generates the Result. This would allow it to handle responses from SaaS that don't signal errors with explicit response status or change the response content, reasonPhrase and even a status code if needed.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default org.mule.runtime.http.api.domain.message.response.HttpResponse	intercept(InterceptionHttpRequest httpRequest, org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage) Process an HttpResponse and generate a new one or return the one provided.
default boolean	match(InterceptionHttpRequest httpRequest, org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage) Defines if this interceptor should process the HttpResponse.

Method Detail

match

default boolean match(InterceptionHttpRequest httpRequest,
                      org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse,
                      org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)

Defines if this interceptor should process the HttpResponse.

Parameters:

httpRequest - the HTTP request that was executed against the server.

httpResponse - the server response to be intercepted. Entity's content could be read more than once as it is backed up * by repeatable streaming from Mule.

expressionLanguage - Mule's ExpressionLanguage to allow using expressions for resolving the interception.

Returns:

if true the intercept(InterceptionHttpRequest, HttpResponse, ExpressionLanguage) method will be called, otherwise not.

intercept

default org.mule.runtime.http.api.domain.message.response.HttpResponse intercept(InterceptionHttpRequest httpRequest,
                                                                                 org.mule.runtime.http.api.domain.message.response.HttpResponse httpResponse,
                                                                                 org.mule.runtime.api.el.ExpressionLanguage expressionLanguage)

Process an HttpResponse and generate a new one or return the one provided.

Parameters:

httpRequest - the HTTP request that was executed against the server.

httpResponse - the server response to be intercepted. Entity's content could be read more than once as it is backed up by repeatable streaming from Mule.

expressionLanguage - Mule's ExpressionLanguage to allow using expressions for resolving the interception.

Returns:

the same or a new and modified HttpResponse.