org.springframework.integration.webflux.dsl

Class WebFluxMessageHandlerSpec

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

org.springframework.integration.dsl.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.MessageHandlerSpec<S,E>

org.springframework.integration.http.dsl.BaseHttpMessageHandlerSpec<WebFluxMessageHandlerSpec,WebFluxRequestExecutingMessageHandler>

org.springframework.integration.webflux.dsl.WebFluxMessageHandlerSpec

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<WebFluxRequestExecutingMessageHandler>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class WebFluxMessageHandlerSpec
extends BaseHttpMessageHandlerSpec<WebFluxMessageHandlerSpec,WebFluxRequestExecutingMessageHandler>

The BaseHttpMessageHandlerSpec implementation for the WebFluxRequestExecutingMessageHandler.

Since:

5.0

Author:

Shiliang Li, Artem Bilan, Abhijit Sarkar, Gary Russell

See Also:

WebFluxRequestExecutingMessageHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected WebClient	webClient

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebFluxMessageHandlerSpec(Expression uriExpression, WebClient webClient)
protected	WebFluxMessageHandlerSpec(String uri, WebClient webClient)
protected	WebFluxMessageHandlerSpec(URI uri, WebClient webClient)

Method Summary

Modifier and Type	Method and Description
WebFluxMessageHandlerSpec	bodyExtractor(BodyExtractor<?,ClientHttpResponse> bodyExtractor) Specify a BodyExtractor as an alternative to the expectedResponseType to allow to get low-level access to the received ClientHttpResponse.
protected WebFluxMessageHandlerSpec	expectReply(boolean expectReply)
protected boolean	isClientSet()
WebFluxMessageHandlerSpec	publisherElementType(Class<?> publisherElementType) Configure a type for a request Publisher elements.
WebFluxMessageHandlerSpec	publisherElementType(ParameterizedTypeReference<?> publisherElementType) Configure a ParameterizedTypeReference for a request Publisher elements.
WebFluxMessageHandlerSpec	publisherElementTypeExpression(Expression publisherElementTypeExpression) Configure a SpEL expression to evaluate a request Publisher elements type at runtime against a request message.
<P> WebFluxMessageHandlerSpec	publisherElementTypeFunction(java.util.function.Function<Message<P>,?> typeFunction) Configure a Function to evaluate a request Publisher elements type at runtime against a request message.
WebFluxMessageHandlerSpec	replyPayloadToFlux(boolean replyPayloadToFlux) The boolean flag to identify if the reply payload should be as a Flux from the response body or as resolved value from the Mono of the response body.

Methods inherited from class org.springframework.integration.http.dsl.BaseHttpMessageHandlerSpec

charset, encodeUri, encodingMode, expectedResponseType, expectedResponseType, expectedResponseTypeExpression, expectedResponseTypeFunction, extractPayload, getComponentsToRegister, headerMapper, httpMethod, httpMethodExpression, httpMethodFunction, mappedRequestHeaders, mappedResponseHeaders, transferCookies, uriVariable, uriVariable, uriVariable, uriVariableExpressions, uriVariablesExpression, uriVariablesExpression, uriVariablesFunction

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Field Detail

webClient

protected final WebClient webClient

Constructor Detail

WebFluxMessageHandlerSpec

protected WebFluxMessageHandlerSpec(URI uri,
                                    WebClient webClient)

WebFluxMessageHandlerSpec

protected WebFluxMessageHandlerSpec(String uri,
                                    WebClient webClient)

WebFluxMessageHandlerSpec

protected WebFluxMessageHandlerSpec(Expression uriExpression,
                                    WebClient webClient)

Method Detail

replyPayloadToFlux

public WebFluxMessageHandlerSpec replyPayloadToFlux(boolean replyPayloadToFlux)

The boolean flag to identify if the reply payload should be as a Flux from the response body or as resolved value from the Mono of the response body. Defaults to false - simple value is pushed downstream. Makes sense when expectedResponseType is configured.

Parameters:

replyPayloadToFlux - represent reply payload as a Flux or as a value from the Mono.

Returns:

the spec

Since:

5.0.1

See Also:

WebFluxRequestExecutingMessageHandler.setReplyPayloadToFlux(boolean)

bodyExtractor

public WebFluxMessageHandlerSpec bodyExtractor(BodyExtractor<?,ClientHttpResponse> bodyExtractor)

Specify a BodyExtractor as an alternative to the expectedResponseType to allow to get low-level access to the received ClientHttpResponse.

Parameters:

bodyExtractor - the BodyExtractor to use.

Returns:

the spec

Since:

5.0.1

See Also:

WebFluxRequestExecutingMessageHandler.setBodyExtractor(BodyExtractor)

publisherElementType

public WebFluxMessageHandlerSpec publisherElementType(Class<?> publisherElementType)

Configure a type for a request Publisher elements.

Parameters:

publisherElementType - the type of the request Publisher elements.

Returns:

the spec

Since:

5.2

See Also:

WebFluxRequestExecutingMessageHandler.setPublisherElementType(java.lang.Class<?>)

publisherElementType

public WebFluxMessageHandlerSpec publisherElementType(ParameterizedTypeReference<?> publisherElementType)

Configure a ParameterizedTypeReference for a request Publisher elements.

Parameters:

publisherElementType - the type of the request Publisher elements.

Returns:

the spec

Since:

5.2

See Also:

WebFluxRequestExecutingMessageHandler.setPublisherElementType(java.lang.Class<?>)

publisherElementTypeFunction

public <P> WebFluxMessageHandlerSpec publisherElementTypeFunction(java.util.function.Function<Message<P>,?> typeFunction)

Configure a Function to evaluate a request Publisher elements type at runtime against a request message.

Type Parameters:

P - the expected payload type.

Parameters:

typeFunction - the Function to evaluate a type for the request Publisher elements.

Returns:

the spec

Since:

5.2

See Also:

WebFluxRequestExecutingMessageHandler.setPublisherElementTypeExpression(Expression)

publisherElementTypeExpression

public WebFluxMessageHandlerSpec publisherElementTypeExpression(Expression publisherElementTypeExpression)

Configure a SpEL expression to evaluate a request Publisher elements type at runtime against a request message.

Parameters:

publisherElementTypeExpression - the expression to evaluate a type for the request Publisher elements.

Returns:

the spec

Since:

5.2

See Also:

WebFluxRequestExecutingMessageHandler.setPublisherElementTypeExpression(Expression)

isClientSet

protected boolean isClientSet()

Specified by:

isClientSet in class BaseHttpMessageHandlerSpec<WebFluxMessageHandlerSpec,WebFluxRequestExecutingMessageHandler>

expectReply

protected WebFluxMessageHandlerSpec expectReply(boolean expectReply)

Overrides:

expectReply in class BaseHttpMessageHandlerSpec<WebFluxMessageHandlerSpec,WebFluxRequestExecutingMessageHandler>