Package org.springframework.integration.jdbc

Class JdbcMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.jdbc.JdbcMessageHandler

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 JdbcMessageHandler
extends AbstractMessageHandler

A message handler that executes an SQL update. Dynamic query parameters are supported through the SqlParameterSourceFactory abstraction, the default implementation of which wraps the message so that its bean properties can be referred to by name in the query string, e.g.

 INSERT INTO ITEMS (MESSAGE_ID, PAYLOAD) VALUES (:headers[id], :payload)
 

When a message payload is an instance of Iterable, a NamedParameterJdbcOperations.batchUpdate(String, SqlParameterSource[]) is performed, where each SqlParameterSource instance is based on items wrapped into an internal Message implementation with headers from the request message. The item is wrapped only if it is not a Message already.

When a preparedStatementSetter is configured, it is applied for each item in the appropriate JdbcOperations.batchUpdate(String, BatchPreparedStatementSetter) function.

NOTE: The batch update is not supported when keysGenerated is in use. N.B. do not use quotes to escape the header keys. The default SQL parameter source (from Spring JDBC) can also handle headers with dotted names (e.g. business.id)

Since:

2.0

Author:

Dave Syer, Artem Bilan, Trung Pham

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
JdbcMessageHandler(DataSource dataSource, String updateSql)	Constructor taking DataSource from which the DB Connection can be obtained and the select query to execute to retrieve new rows.
JdbcMessageHandler(JdbcOperations jdbcOperations, String updateSql)	Constructor taking JdbcOperations instance to use for query execution and the select query to execute to retrieve new rows.

Method Summary

Modifier and Type	Method	Description
protected List<? extends Map<String,Object>>	executeUpdateQuery(Message<?> message, boolean keysGenerated)	Execute an update for the provided message and generated keys flag.
String	getComponentType()	Subclasses may implement this method to provide component type information.
protected void	handleMessageInternal(Message<?> message)	Executes the update, passing the message into the SqlParameterSourceFactory.
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setKeysGenerated(boolean keysGenerated)	Flag to indicate that the update query is an insert with auto-generated keys, which will be logged at debug level.
void	setPreparedStatementSetter(MessagePreparedStatementSetter preparedStatementSetter)	Specify a MessagePreparedStatementSetter to populate parameters on the PreparedStatement with the Message context.
void	setSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)	Configure an SqlParameterSourceFactory.

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

JdbcMessageHandler

public JdbcMessageHandler(DataSource dataSource,
 String updateSql)

Constructor taking DataSource from which the DB Connection can be obtained and the select query to execute to retrieve new rows.

Parameters:

dataSource - Must not be null

updateSql - query to execute

JdbcMessageHandler

public JdbcMessageHandler(JdbcOperations jdbcOperations,
 String updateSql)

Constructor taking JdbcOperations instance to use for query execution and the select query to execute to retrieve new rows.

Parameters:

jdbcOperations - instance to use for query execution

updateSql - query to execute

Method Details

setKeysGenerated

public void setKeysGenerated(boolean keysGenerated)

Flag to indicate that the update query is an insert with auto-generated keys, which will be logged at debug level.

Parameters:

keysGenerated - the flag value to set

setSqlParameterSourceFactory

public void setSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

Configure an SqlParameterSourceFactory.

Parameters:

sqlParameterSourceFactory - the SqlParameterSourceFactory to use.

setPreparedStatementSetter

public void setPreparedStatementSetter(@Nullable
 MessagePreparedStatementSetter preparedStatementSetter)

Specify a MessagePreparedStatementSetter to populate parameters on the PreparedStatement with the Message context.

This is a low-level alternative to the SqlParameterSourceFactory.

Parameters:

preparedStatementSetter - the MessagePreparedStatementSetter to set.

Since:

4.2

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)

Executes the update, passing the message into the SqlParameterSourceFactory.

Specified by:

handleMessageInternal in class AbstractMessageHandler

executeUpdateQuery

protected List<? extends Map<String,Object>> executeUpdateQuery(Message<?> message,
 boolean keysGenerated)

Execute an update for the provided message and generated keys flag.

Parameters:

message - the message to use for update query params.

keysGenerated - generate key or not.

Returns:

a generated keys for update.