Package org.springframework.integration.mongodb.outbound

Class MongoDbOutboundGateway

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.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.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.integration.context.ExpressionCapable, org.springframework.integration.context.Orderable, org.springframework.integration.core.MessageProducer, org.springframework.integration.handler.HeaderPropagationAware, org.springframework.integration.IntegrationPattern, org.springframework.integration.support.context.NamedComponent, org.springframework.integration.support.management.IntegrationManagement, org.springframework.integration.support.management.TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>
public class MongoDbOutboundGateway extends org.springframework.integration.handler.AbstractReplyProducingMessageHandler
Makes outbound operations to query a MongoDb database using a MongoOperations.
Since:
5.0

  • Nested Class Summary

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

    org.springframework.integration.handler.AbstractReplyProducingMessageHandler.RequestHandler

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

    org.springframework.integration.support.management.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
    Description
    MongoDbOutboundGateway(org.springframework.data.mongodb.core.MongoOperations mongoTemplate)
     
    MongoDbOutboundGateway(org.springframework.data.mongodb.MongoDatabaseFactory mongoDbFactory)
     
    MongoDbOutboundGateway(org.springframework.data.mongodb.MongoDatabaseFactory mongoDbFactory, org.springframework.data.mongodb.core.convert.MongoConverter mongoConverter)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doInit()
     
    protected Object
    handleRequestMessage(org.springframework.messaging.Message<?> requestMessage)
     
    void
    setCollectionNameExpression(org.springframework.expression.Expression collectionNameExpression)
     
    void
    setCollectionNameExpressionString(String collectionNameExpressionString)
     
    void
    setEntityClass(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(String queryExpressionString)
     

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

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

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

    addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, 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, 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, getComponentName, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, 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 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

  • Constructor Details

    • MongoDbOutboundGateway

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

    • MongoDbOutboundGateway

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

    • MongoDbOutboundGateway

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

  • Method Details

    • setQueryExpression

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

    • setQueryExpressionString

      public void setQueryExpressionString(String queryExpressionString)

    • 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(Class<?> entityClass)

    • setCollectionNameExpression

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

    • setCollectionNameExpressionString

      public void setCollectionNameExpressionString(String collectionNameExpressionString)

    • setMongoConverter

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

    • doInit

      protected void doInit()
      Overrides:
      doInit in class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

    • handleRequestMessage

      protected Object handleRequestMessage(org.springframework.messaging.Message<?> requestMessage)
      Specified by:
      handleRequestMessage in class org.springframework.integration.handler.AbstractReplyProducingMessageHandler