Package org.springframework.integration.mongodb.outbound

Class MongoDbStoringMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.mongodb.outbound.MongoDbStoringMessageHandler

All Implemented Interfaces:

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

public class MongoDbStoringMessageHandler
extends AbstractMessageHandler

Implementation of MessageHandler which writes Message payload into a MongoDb collection identified by evaluation of the collectionNameExpression.

Since:

2.2

Author:

Amol Nayak, Oleg Zhurakousky, 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.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
MongoDbStoringMessageHandler(MongoOperations mongoTemplate)	Will construct this instance using fully created and initialized instance of provided MongoOperations.
MongoDbStoringMessageHandler(MongoDatabaseFactory mongoDbFactory)	Will construct this instance using provided MongoDatabaseFactory.

Method Summary

Modifier and Type	Method	Description
String	getComponentType()	Subclasses may implement this method to provide component type information.
protected void	handleMessageInternal(Message<?> message)
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setCollectionNameExpression(Expression collectionNameExpression)	Set the SpEL Expression that should resolve to a collection name used by MongoOperations to store data
void	setMongoConverter(MongoConverter mongoConverter)	Allow providing custom MongoConverter used to assist in serialization of data written to MongoDb.

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

MongoDbStoringMessageHandler

public MongoDbStoringMessageHandler(MongoDatabaseFactory mongoDbFactory)

Will construct this instance using provided MongoDatabaseFactory.

Parameters:

mongoDbFactory - The mongodb factory.

MongoDbStoringMessageHandler

public MongoDbStoringMessageHandler(MongoOperations mongoTemplate)

Will construct this instance using fully created and initialized instance of provided MongoOperations.

Parameters:

mongoTemplate - The MongoOperations implementation.

Method Details

setMongoConverter

public void setMongoConverter(MongoConverter mongoConverter)

Allow providing custom MongoConverter used to assist in serialization of data written to MongoDb. Only allowed if this instance was constructed with a MongoDatabaseFactory.

Parameters:

mongoConverter - The mongo converter.

setCollectionNameExpression

public void setCollectionNameExpression(Expression collectionNameExpression)

Set the SpEL Expression that should resolve to a collection name used by MongoOperations to store data

Parameters:

collectionNameExpression - The collection name expression.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

handleMessageInternal

protected void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler