Package io.fluxcapacitor.javaclient.web

Class ForwardingWebConsumer

java.lang.Object

io.fluxcapacitor.javaclient.web.ForwardingWebConsumer

All Implemented Interfaces:

AutoCloseable

public class ForwardingWebConsumer
extends Object
implements AutoCloseable

A specialized, opt-in {web request consumer that forwards incoming MessageType.WEBREQUEST messages to a locally running HTTP server.

This class is internally initialized when FluxCapacitorBuilder.forwardWebRequestsToLocalServer(int) is configured. Rather than routing messages through Flux’s internal handler infrastructure, it converts web requests into raw HTTP requests and asynchronously sends them to http://localhost:port.

Purpose

This mechanism exists primarily for interoperability: it allows applications to integrate with their own HTTP servers (e.g., frameworks like Spring Boot, Jooby, or Vert.x) rather than adopting the Flux message-based web handler framework.

⚠️ Caution: Limited Use Case

While supported, use of this component is generally discouraged. It bypasses the core pull-based message consumption model of Flux Capacitor by pushing messages asynchronously to a local server. This introduces a risk of losing delivery guarantees, tracing consistency, and handler lifecycle control.

Consider using @HandleWeb-based handlers and declarative routing instead.

How It Works

• Consumes WEBREQUEST messages via a Tracker
• For each message, creates a corresponding HttpRequest and sends it to localhost
• Captures the HttpResponse and converts it back into a SerializedMessage
• Publishes the result using the WEBRESPONSE GatewayClient

Features

• Header forwarding with filtering of restricted headers
• Support for request correlation and metadata propagation
• Graceful handling of 404s (configurable via LocalServerConfig#isIgnore404())
• Fallback error response creation if the target server fails

See Also:

• FluxCapacitorBuilder.forwardWebRequestsToLocalServer(int)
• WebRequest
• WebResponse
• Tracker

Constructor Summary

Constructors

Constructor	Description
ForwardingWebConsumer(LocalServerConfig localServerConfig, ConsumerConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	close()
protected HttpRequest	createRequest(SerializedMessage m)
protected Map<String,String>	getCorrelationData(SerializedMessage m)
protected boolean	isRestricted(String headerName)
void	start(FluxCapacitor fluxCapacitor)
protected SerializedMessage	toMessage(Throwable error, Map<String,String> correlationData)
protected SerializedMessage	toMessage(HttpResponse<byte[]> response, Map<String,String> correlationData)

Methods inherited from class java.lang.Object

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

Constructor Details

ForwardingWebConsumer

public ForwardingWebConsumer(LocalServerConfig localServerConfig,
 ConsumerConfiguration configuration)

Method Details

start

public void start(FluxCapacitor fluxCapacitor)

getCorrelationData

protected Map<String,String> getCorrelationData(SerializedMessage m)

createRequest

protected HttpRequest createRequest(SerializedMessage m)

isRestricted

protected boolean isRestricted(String headerName)

toMessage

protected SerializedMessage toMessage(HttpResponse<byte[]> response,
 Map<String,String> correlationData)

toMessage

protected SerializedMessage toMessage(Throwable error,
 Map<String,String> correlationData)

close

public void close()

Specified by:

close in interface AutoCloseable