Package io.gravitee.gateway.reactive.api.context.http

Interface HttpMessageExecutionContext

All Superinterfaces:

BaseExecutionContext, BaseMessageExecutionContext, HttpBaseExecutionContext

All Known Subinterfaces:

ExecutionContext, HttpExecutionContext, MessageExecutionContext

public interface HttpMessageExecutionContext
extends HttpBaseExecutionContext, BaseMessageExecutionContext

Specialize http execution context allowing access to an HttpMessageRequest and HttpMessageResponse that manipulates flow of messages.

Author:

Jeoffrey HAEYAERT (jeoffrey.haeyaert at graviteesource.com), GraviteeSource Team

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEMPLATE_ATTRIBUTE_MESSAGE

Fields inherited from interface io.gravitee.gateway.reactive.api.context.base.BaseExecutionContext

TEMPLATE_ATTRIBUTE_CONTEXT

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Flowable<Message>	interruptMessagesWith(ExecutionFailure failure)	Same as BaseMessageExecutionContext.interruptMessages() but with an ExecutionFailure object that indicates that the execution has failed.
io.reactivex.rxjava3.core.Maybe<Message>	interruptMessageWith(ExecutionFailure failure)	Same as BaseMessageExecutionContext#interruptMessagesWith(ExecutionFailure) but at message level
HttpMessageRequest	request()	Get the current request attached to this execution context.
HttpMessageResponse	response()	Get the current response attached to this execution context.

Methods inherited from interface io.gravitee.gateway.reactive.api.context.base.BaseExecutionContext

getAttribute, getAttributeAsList, getAttributeNames, getAttributes, getComponent, getInternalAttribute, getInternalAttributes, getTemplateEngine, getTracer, localAddress, putAttribute, putInternalAttribute, remoteAddress, removeAttribute, removeInternalAttribute, setAttribute, setInternalAttribute, timestamp, tlsSession, warnWith

Methods inherited from interface io.gravitee.gateway.reactive.api.context.base.BaseMessageExecutionContext

getTemplateEngine, interruptMessage, interruptMessages

Methods inherited from interface io.gravitee.gateway.reactive.api.context.http.HttpBaseExecutionContext

metrics

Field Details

TEMPLATE_ATTRIBUTE_MESSAGE

static final String TEMPLATE_ATTRIBUTE_MESSAGE

See Also:

• Constant Field Values

Method Details

request

HttpMessageRequest request()

Get the current request attached to this execution context.

Specified by:

request in interface HttpBaseExecutionContext

Returns:

the request attached to this execution context.

response

HttpMessageResponse response()

Get the current response attached to this execution context.

Specified by:

response in interface HttpBaseExecutionContext

Returns:

the response attached to this execution context.

interruptMessagesWith

io.reactivex.rxjava3.core.Flowable<Message> interruptMessagesWith(ExecutionFailure failure)

Same as BaseMessageExecutionContext.interruptMessages() but with an ExecutionFailure object that indicates that the execution has failed. The ExecutionFailure can be processed in order to build a proper response (ex: based on templating, with appropriate accept-encoding, ...).

interruptMessageWith

io.reactivex.rxjava3.core.Maybe<Message> interruptMessageWith(ExecutionFailure failure)

Same as BaseMessageExecutionContext#interruptMessagesWith(ExecutionFailure) but at message level