public class JdbcMessageHandler extends AbstractMessageHandler
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 FOOS (MESSAGE_ID, PAYLOAD) VALUES (:headers[id], :payload)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
)IntegrationManagement.ManagementOverrides
EXPRESSION_PARSER, logger
METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME
Constructor and Description |
---|
JdbcMessageHandler(javax.sql.DataSource dataSource,
java.lang.String updateSql)
Constructor taking
DataSource from which the DB Connection can be obtained and the select query to
execute to retrieve new rows. |
JdbcMessageHandler(org.springframework.jdbc.core.JdbcOperations jdbcOperations,
java.lang.String updateSql)
Constructor taking
JdbcOperations instance to use for query execution and the select query to execute to
retrieve new rows. |
Modifier and Type | Method and Description |
---|---|
protected java.util.List<? extends java.util.Map<java.lang.String,java.lang.Object>> |
executeUpdateQuery(org.springframework.messaging.Message<?> message,
boolean keysGenerated) |
java.lang.String |
getComponentType()
Subclasses may implement this method to provide component type information.
|
protected void |
handleMessageInternal(org.springframework.messaging.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) |
void |
setUpdateSql(java.lang.String updateSql) |
configureMetrics, getActiveCount, getActiveCountLong, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getOverrides, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, onComplete, onError, onNext, onSubscribe, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled
afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getComponentName
public JdbcMessageHandler(javax.sql.DataSource dataSource, java.lang.String updateSql)
DataSource
from which the DB Connection can be obtained and the select query to
execute to retrieve new rows.dataSource
- Must not be nullupdateSql
- query to executepublic JdbcMessageHandler(org.springframework.jdbc.core.JdbcOperations jdbcOperations, java.lang.String updateSql)
JdbcOperations
instance to use for query execution and the select query to execute to
retrieve new rows.jdbcOperations
- instance to use for query executionupdateSql
- query to executepublic void setKeysGenerated(boolean keysGenerated)
keysGenerated
- the flag value to setpublic void setUpdateSql(java.lang.String updateSql)
public void setSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)
public void setPreparedStatementSetter(MessagePreparedStatementSetter preparedStatementSetter)
MessagePreparedStatementSetter
to populate parameters on the
PreparedStatement
with the Message
context.
This is a low-level alternative to the SqlParameterSourceFactory
.
preparedStatementSetter
- the MessagePreparedStatementSetter
to set.public java.lang.String getComponentType()
IntegrationObjectSupport
getComponentType
in interface NamedComponent
getComponentType
in class AbstractMessageHandler
protected void onInit() throws java.lang.Exception
IntegrationObjectSupport
onInit
in class AbstractMessageHandler
java.lang.Exception
- Any exception.protected void handleMessageInternal(org.springframework.messaging.Message<?> message) throws java.lang.Exception
SqlParameterSourceFactory
.handleMessageInternal
in class AbstractMessageHandler
java.lang.Exception
protected java.util.List<? extends java.util.Map<java.lang.String,java.lang.Object>> executeUpdateQuery(org.springframework.messaging.Message<?> message, boolean keysGenerated)