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

Type Parameters:: T - The payload type.

All Implemented Interfaces:: Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, MessageSource<T>, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement

Direct Known Subclasses:: MongoDbMessageSource, ReactiveMongoDbMessageSource

public abstract class AbstractMongoDbMessageSource<T>
extends AbstractMessageSource<T>
implements ApplicationContextAware

An AbstractMessageSource extension for common MongoDB sources options and support methods.

Since:: 5.5
Author:: Artem Bilan

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 Expression 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

Modifier Constructor Description

protected AbstractMongoDbMessageSource(Expression queryExpression)

Method Summary

Modifier and Type	Method	Description
`protected String`	`evaluateCollectionNameExpression()`
`protected Query`	`evaluateQueryExpression()`
`protected Update`	`evaluateUpdateExpression()`
`ApplicationContext`	`getApplicationContext()`
`protected Query`	`getByIdInQuery(Collection<?> entities)`
`Expression`	`getCollectionNameExpression()`
`Class<?>`	`getEntityClass()`
`MongoConverter`	`getMongoConverter()`
`Expression`	`getUpdateExpression()`
`protected org.springframework.data.util.Pair<String,Object>`	`idForEntity(Object entity)`
`boolean`	`isExpectSingleResult()`
`protected boolean`	`isInitialized()`
`protected void`	`onInit()`
`void`	`setApplicationContext(ApplicationContext applicationContext)`
`void`	`setCollectionNameExpression(Expression collectionNameExpression)`	Set the SpEL `Expression` that should resolve to a collection name used by the `Query`.
`void`	`setEntityClass(Class<?> entityClass)`	Set the type of the entityClass that will be passed to the find MongoDb template operation.
`void`	`setExpectSingleResult(boolean expectSingleResult)`	Manage which find* method to invoke.
`protected void`	`setInitialized(boolean initialized)`
`void`	`setMongoConverter(MongoConverter mongoConverter)`	Provide a custom `MongoConverter` used to assist in deserialization data read from MongoDb.
`void`	`setUpdateExpression(Expression updateExpression)`	Specify an optional `update` for just polled records from the collection.

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

buildMessage, destroy, doReceive, 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

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

getIntegrationPatternType

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

getComponentType

Field Details
- queryExpression
  
  protected final Expression queryExpression
Constructor Details
- AbstractMongoDbMessageSource
  
  protected AbstractMongoDbMessageSource(Expression queryExpression)
Method Details
- setEntityClass
  
  public void setEntityClass(Class<?> entityClass)
  
  Set the type of the entityClass that will be passed to the find MongoDb template operation. Default is DBObject.
  
  Parameters:
  
  entityClass - The entity class.
- setExpectSingleResult
  
  public void setExpectSingleResult(boolean expectSingleResult)
  
  Manage which find* method to invoke. Default is 'false', which means the AbstractMessageSource.receive() method will use the find() method. If set to 'true', AbstractMessageSource.receive() will use findOne(Query, Class), and the payload of the returned Message will be the returned target Object of type identified by entityClass instead of a List.
  
  Parameters:
  
  expectSingleResult - true if a single result is expected.
- setCollectionNameExpression
  
  public void setCollectionNameExpression(Expression collectionNameExpression)
  
  Set the SpEL Expression that should resolve to a collection name used by the Query. The resulting collection name will be included in the MongoHeaders.COLLECTION_NAME header.
  
  Parameters:
  
  collectionNameExpression - The collection name expression.
- setMongoConverter
  
  public void setMongoConverter(MongoConverter mongoConverter)
  
  Provide a custom MongoConverter used to assist in deserialization data read from MongoDb.
  
  Parameters:
  
  mongoConverter - The mongo converter.
- setUpdateExpression
  
  public void setUpdateExpression(Expression updateExpression)
  
  Specify an optional update for just polled records from the collection.
  
  Parameters:
  
  updateExpression - SpEL expression for an UpdateDefinition.
  
  Since:
  
  5.5
- setApplicationContext
  
  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
  
  Specified by:
  
  setApplicationContext in interface ApplicationContextAware
  
  Throws:
  
  BeansException
- getCollectionNameExpression
  
  public Expression getCollectionNameExpression()
- getMongoConverter
  
  public MongoConverter getMongoConverter()
- getEntityClass
  
  public Class<?> getEntityClass()
- isExpectSingleResult
  
  public boolean isExpectSingleResult()
- getUpdateExpression
  
  public Expression getUpdateExpression()
- getApplicationContext
  
  public ApplicationContext getApplicationContext()
- setInitialized
  
  protected void setInitialized(boolean initialized)
- isInitialized
  
  protected boolean isInitialized()
- onInit
  
  protected void onInit()
  
  Overrides:
  
  onInit in class AbstractExpressionEvaluator
- evaluateQueryExpression
  
  protected Query evaluateQueryExpression()
- evaluateCollectionNameExpression
  
  protected String evaluateCollectionNameExpression()
- getByIdInQuery
  
  protected Query getByIdInQuery(Collection<?> entities)
- idForEntity
  
  protected org.springframework.data.util.Pair<String,Object> idForEntity(Object entity)
- evaluateUpdateExpression
  
  @Nullable protected Update evaluateUpdateExpression()

Class AbstractMongoDbMessageSource<T>

Nested Class Summary

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

Field Summary

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

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

Constructor Summary