org.springframework.integration.mongodb.outbound

Class MongoDbOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.mongodb.outbound.MongoDbOutboundGateway

All Implemented Interfaces:

org.reactivestreams.Subscriber<org.springframework.messaging.Message<?>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>

public class MongoDbOutboundGateway
extends AbstractReplyProducingMessageHandler

Makes outbound operations to query a MongoDb database using a MongoOperations

Since:

5.0

Author:

Xavier Padró, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

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

IntegrationManagement.ManagementOverrides

Field Summary

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

Constructor and Description
MongoDbOutboundGateway(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory)
MongoDbOutboundGateway(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory, org.springframework.data.mongodb.core.convert.MongoConverter mongoConverter)
MongoDbOutboundGateway(org.springframework.data.mongodb.core.MongoOperations mongoTemplate)

Method Summary

Modifier and Type	Method and Description
protected void	doInit()
protected java.lang.Object	handleRequestMessage(org.springframework.messaging.Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
void	setCollectionCallback(org.springframework.data.mongodb.core.CollectionCallback<?> collectionCallback) Deprecated. in favor of setMessageCollectionCallback(MessageCollectionCallback). Will be removed in 5.2
void	setCollectionNameExpression(org.springframework.expression.Expression collectionNameExpression)
void	setCollectionNameExpressionString(java.lang.String collectionNameExpressionString)
void	setEntityClass(java.lang.Class<?> entityClass)
void	setExpectSingleResult(boolean expectSingleResult)
void	setMessageCollectionCallback(MessageCollectionCallback<?> collectionCallback) Specify a MessageCollectionCallback to perform against MongoDB collection in the request message context.
void	setMongoConverter(org.springframework.data.mongodb.core.convert.MongoConverter mongoConverter)
void	setQueryExpression(org.springframework.expression.Expression queryExpression)
void	setQueryExpressionString(java.lang.String queryExpressionString)

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

doInvokeAdvisedRequestHandler, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

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

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

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

configureMetrics, getActiveCount, getActiveCountLong, getComponentType, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getOverrides, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, onComplete, onError, onNext, onSubscribe, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, 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 org.springframework.integration.support.context.NamedComponent

getComponentName

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Constructor Detail

MongoDbOutboundGateway

public MongoDbOutboundGateway(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory)

MongoDbOutboundGateway

public MongoDbOutboundGateway(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory,
                              org.springframework.data.mongodb.core.convert.MongoConverter mongoConverter)

MongoDbOutboundGateway

public MongoDbOutboundGateway(org.springframework.data.mongodb.core.MongoOperations mongoTemplate)

Method Detail

setQueryExpression

public void setQueryExpression(org.springframework.expression.Expression queryExpression)

setQueryExpressionString

public void setQueryExpressionString(java.lang.String queryExpressionString)

setCollectionCallback

@Deprecated
public void setCollectionCallback(org.springframework.data.mongodb.core.CollectionCallback<?> collectionCallback)

Deprecated. in favor of setMessageCollectionCallback(MessageCollectionCallback). Will be removed in 5.2

Specify a CollectionCallback to perform against MongoDB collection.

Parameters:

collectionCallback - the callback to perform against MongoDB collection.

setMessageCollectionCallback

public void setMessageCollectionCallback(MessageCollectionCallback<?> collectionCallback)

Specify a MessageCollectionCallback to perform against MongoDB collection in the request message context.

Parameters:

collectionCallback - the callback to perform against MongoDB collection.

Since:

5.0.11

setExpectSingleResult

public void setExpectSingleResult(boolean expectSingleResult)

setEntityClass

public void setEntityClass(java.lang.Class<?> entityClass)

setCollectionNameExpression

public void setCollectionNameExpression(org.springframework.expression.Expression collectionNameExpression)

setCollectionNameExpressionString

public void setCollectionNameExpressionString(java.lang.String collectionNameExpressionString)

setMongoConverter

public void setMongoConverter(org.springframework.data.mongodb.core.convert.MongoConverter mongoConverter)

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected java.lang.Object handleRequestMessage(org.springframework.messaging.Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.