Class MockMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.test.mock.MockMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class MockMessageHandler
extends AbstractMessageProducingHandler

The AbstractMessageProducingHandler extension for the mocking purpose in tests.

The provided Consumers and Functions are applied to the incoming messages one at a time until the last, which is applied for all subsequent messages. The similar behavior exists in the Mockito.doReturn(Object toBeReturned, Object... toBeReturnedNext).

Typically is used as a chain of stub actions:

 
      MockIntegration.mockMessageHandler()
               .handleNext(...)
               .handleNext(...)
               .handleNextAndReply(...)
               .handleNextAndReply(...)
               .handleNext(...)
               .handleNextAndReply(...);
 
 

Since:

5.0

Author:

Artem Bilan, Christian Tzolov

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	hasReplies
protected Function<Message<?>, ?>	lastFunction
protected final List<Function<Message<?>, ?>>	messageFunctions

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MockMessageHandler(org.mockito.ArgumentCaptor<Message<?>> messageArgumentCaptor)

Method Summary

Modifier and Type	Method	Description
protected void	handleMessageInternal(Message<?> message)
MockMessageHandler	handleNext(Consumer<Message<?>> nextMessageConsumer)	Add the Consumer to the stack to handle the next incoming message.
MockMessageHandler	handleNextAndReply(Function<Message<?>, ?> nextMessageFunction)	Add the Function to the stack to handle the next incoming message and produce reply for it.

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, onInit, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, destroy, getComponentType, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Field Details

messageFunctions

protected final List<Function<Message<?>, ?>> messageFunctions

lastFunction

protected Function<Message<?>, ?> lastFunction

hasReplies

protected boolean hasReplies

Constructor Details

MockMessageHandler

protected MockMessageHandler(org.mockito.ArgumentCaptor<Message<?>> messageArgumentCaptor)

Method Details

handleNext

public MockMessageHandler handleNext(Consumer<Message<?>> nextMessageConsumer)

Add the Consumer to the stack to handle the next incoming message.

Parameters:

nextMessageConsumer - the Consumer to handle the next incoming message.

Returns:

this

handleNextAndReply

public MockMessageHandler handleNextAndReply(Function<Message<?>, ?> nextMessageFunction)

Add the Function to the stack to handle the next incoming message and produce reply for it.

Parameters:

nextMessageFunction - the Function to handle the next incoming message.

Returns:

this

handleMessageInternal

protected void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler