Package org.springframework.integration.mongodb.inbound

Class MongoDbMessageSource

java.lang.Object

org.springframework.integration.util.AbstractExpressionEvaluator

org.springframework.integration.endpoint.AbstractMessageSource<T>

org.springframework.integration.mongodb.inbound.AbstractMongoDbMessageSource<Object>

org.springframework.integration.mongodb.inbound.MongoDbMessageSource

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, MessageSource<Object>, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement

public class MongoDbMessageSource
extends AbstractMongoDbMessageSource<Object>

An instance of MessageSource which returns a Message with a payload which is the result of execution of a Query. When expectSingleResult is false (default), the MongoDb Query is executed using MongoOperations.find(Query, Class) method which returns a List. The returned List will be used as the payload of the Message returned by the {AbstractMessageSource.receive() method. An empty List is treated as null, thus resulting in no Message returned by the {AbstractMessageSource.receive() method.

When expectSingleResult is true, the MongoOperations.findOne(Query, Class) is used instead, and the message payload will be the single object returned from the query.

Since:

2.2

Author:

Amol Nayak, Oleg Zhurakousky, Yaron Yamin, Artem Bilan, Gary Russell

Nested Class Summary

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.mongodb.inbound.AbstractMongoDbMessageSource

queryExpression

Fields inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

EXPRESSION_PARSER, logger

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

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor	Description
MongoDbMessageSource(MongoOperations mongoTemplate, Expression queryExpression)	Create an instance with the provided MongoOperations and SpEL expression which should resolve to a Mongo 'query' string (see https://www.mongodb.org/display/DOCS/Querying).
MongoDbMessageSource(MongoDatabaseFactory mongoDbFactory, Expression queryExpression)	Create an instance with the provided MongoDatabaseFactory and SpEL expression which should resolve to a MongoDb 'query' string (see https://www.mongodb.org/display/DOCS/Querying).

Method Summary

Modifier and Type	Method	Description
protected Object	doReceive()	Will execute a Query returning its results as the Message payload.
String	getComponentType()
protected void	onInit()

Methods inherited from class org.springframework.integration.mongodb.inbound.AbstractMongoDbMessageSource

evaluateCollectionNameExpression, evaluateQueryExpression, evaluateUpdateExpression, getApplicationContext, getByIdInQuery, getCollectionNameExpression, getEntityClass, getMongoConverter, getUpdateExpression, idForEntity, isExpectSingleResult, isInitialized, setApplicationContext, setCollectionNameExpression, setEntityClass, setExpectSingleResult, setInitialized, setMongoConverter, setUpdateExpression

Methods inherited from class org.springframework.integration.endpoint.AbstractMessageSource

buildMessage, destroy, getBeanName, getComponentName, getManagedName, getManagedType, getOverrides, isLoggingEnabled, receive, registerMetricsCaptor, setBeanName, setHeaderExpressions, setLoggingEnabled, setManagedName, setManagedType

Methods inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, setBeanFactory, setConversionService

Methods inherited from class java.lang.Object

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

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

getThisAs, isObserved, registerObservationRegistry

Methods inherited from interface org.springframework.integration.core.MessageSource

getIntegrationPatternType

Constructor Details

MongoDbMessageSource

public MongoDbMessageSource(MongoDatabaseFactory mongoDbFactory,
 Expression queryExpression)

Create an instance with the provided MongoDatabaseFactory and SpEL expression which should resolve to a MongoDb 'query' string (see https://www.mongodb.org/display/DOCS/Querying). The 'queryExpression' will be evaluated on every call to the AbstractMessageSource.receive() method.

Parameters:

mongoDbFactory - The mongodb factory.

queryExpression - The query expression.

MongoDbMessageSource

public MongoDbMessageSource(MongoOperations mongoTemplate,
 Expression queryExpression)

Create an instance with the provided MongoOperations and SpEL expression which should resolve to a Mongo 'query' string (see https://www.mongodb.org/display/DOCS/Querying). It assumes that the MongoOperations is fully initialized and ready to be used. The 'queryExpression' will be evaluated on every call to the AbstractMessageSource.receive() method.

Parameters:

mongoTemplate - The mongo template.

queryExpression - The query expression.

Method Details

getComponentType

public String getComponentType()

onInit

protected void onInit()

Overrides:

onInit in class AbstractMongoDbMessageSource<Object>

doReceive

protected Object doReceive()

Will execute a Query returning its results as the Message payload. The payload can be either List of elements of objects of type identified by AbstractMongoDbMessageSource.getEntityClass(), or a single element of type identified by AbstractMongoDbMessageSource.getEntityClass() based on the value of AbstractMongoDbMessageSource.isExpectSingleResult() attribute which defaults to 'false' resulting Message with payload of type List. The collection name used in the query will be provided in the MongoHeaders.COLLECTION_NAME header.

Specified by:

doReceive in class AbstractMessageSource<Object>

Returns:

The value returned.