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

Interface HttpMessageRequest

All Superinterfaces:

BaseMessageRequest, BaseRequest, HttpBaseRequest

All Known Subinterfaces:

HttpRequest, MessageRequest, Request

public interface HttpMessageRequest
extends BaseMessageRequest, HttpBaseRequest

Represents a request that can manipulate a flow of messages.

Author:

Guillaume LAMIRAND (guillaume.lamirand at graviteesource.com), GraviteeSource Team

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Flowable<Message>	messages()	Get the request message flow as a Flowable of Message.
void	messages(io.reactivex.rxjava3.core.Flowable<Message> messages)	Set the request message flow.
default io.reactivex.rxjava3.core.Completable	onMessage(Function<Message,io.reactivex.rxjava3.core.Maybe<Message>> onMessage)	Applies a given transformation on each message.
io.reactivex.rxjava3.core.Completable	onMessages(io.reactivex.rxjava3.core.FlowableTransformer<Message,Message> onMessages)	Applies a given transformation on each message.

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

clientIdentifier, contextPath, ended, headers, host, id, localAddress, method, originalHost, parameters, path, pathInfo, pathParameters, remoteAddress, scheme, timestamp, tlsSession, transactionId, uri, version

Method Details

messages

io.reactivex.rxjava3.core.Flowable<Message> messages()

Get the request message flow as a Flowable of Message. WARN: you should not keep a direct reference on the message flow as it could be overridden by others at anytime.

Specified by:

messages in interface BaseMessageRequest

Returns:

a Flowable of Message.

messages

void messages(io.reactivex.rxjava3.core.Flowable<Message> messages)

Set the request message flow. WARN:

• Replacing the message flow DOES NOT take care of the previous message flow in place.
• You MUST ensure to consume the previous message flow when using it.
• You SHOULD consider using onMessages(FlowableTransformer) or onMessage(Function) that may be more appropriate for message transformation.

Specified by:

messages in interface BaseMessageRequest

See Also:

• onMessage(Function)
• onMessages(FlowableTransformer)

onMessages

io.reactivex.rxjava3.core.Completable onMessages(io.reactivex.rxjava3.core.FlowableTransformer<Message,Message> onMessages)

Applies a given transformation on each message. Ex: request.onMessages(messages -> messages.flatMap(message -> transformMyMessage(message)));

Specified by:

onMessages in interface BaseMessageRequest

Parameters:

onMessages - the transformer that will be applied on each message.

Returns:

a Completable that completes once the message transformation has been set up on the message flow (not executed).

onMessage

default io.reactivex.rxjava3.core.Completable onMessage(Function<Message,io.reactivex.rxjava3.core.Maybe<Message>> onMessage)

Applies a given transformation on each message. Ex: Discard a message: request.onMessage(message -> Maybe.empty()); Update a message: request.onMessage(message -> transformMyMessage(message));

Specified by:

onMessage in interface BaseMessageRequest

Parameters:

onMessage - the transformer that will be applied on each message.

Returns:

a Completable that completes once the message transformation has been set up on the message flow (not executed).