Package org.springframework.integration.jdbc

Class JdbcOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.jdbc.JdbcOutboundGateway

All Implemented Interfaces:

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

public class JdbcOutboundGateway
extends AbstractReplyProducingMessageHandler

Since:

2.0

Author:

Dave Syer, Gunnar Hillert, Artem Bilan, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

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
JdbcOutboundGateway(DataSource dataSource, String updateQuery)	Construct an instance based on the provided DataSource and update SQL.
JdbcOutboundGateway(DataSource dataSource, String updateQuery, String selectQuery)	Construct an instance based on the provided DataSource, select and update SQLs.
JdbcOutboundGateway(JdbcOperations jdbcOperations, String updateQuery)	Construct an instance based on the provided JdbcOperations and update SQL.
JdbcOutboundGateway(JdbcOperations jdbcOperations, String updateQuery, String selectQuery)	Construct an instance based on the provided JdbcOperations, select and update SQLs.

Method Summary

Modifier and Type	Method	Description
protected void	doInit()
String	getComponentType()	Subclasses may implement this method to provide component type information.
protected Object	handleRequestMessage(Message<?> requestMessage)	Subclasses must implement this method to handle the request Message.
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	setMaxRows(Integer maxRows)	The maximum number of rows to query.
void	setReplySqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)	/** Set a SqlParameterSourceFactory for select query.
void	setRequestPreparedStatementSetter(MessagePreparedStatementSetter requestPreparedStatementSetter)	Set a MessagePreparedStatementSetter for update query.
void	setRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)	Set a SqlParameterSourceFactory for update query.
void	setRowMapper(RowMapper<?> rowMapper)	Set a select result RowMapper.

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

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, 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, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, 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

JdbcOutboundGateway

public JdbcOutboundGateway(DataSource dataSource,
 String updateQuery)

Construct an instance based on the provided DataSource and update SQL.

Parameters:

dataSource - the DataSource for execution.

updateQuery - the query to execute.

JdbcOutboundGateway

public JdbcOutboundGateway(DataSource dataSource,
 String updateQuery,
 String selectQuery)

Construct an instance based on the provided DataSource, select and update SQLs.

Parameters:

dataSource - the DataSource for execution.

updateQuery - the update to execute.

selectQuery - the select to execute.

JdbcOutboundGateway

public JdbcOutboundGateway(JdbcOperations jdbcOperations,
 String updateQuery)

Construct an instance based on the provided JdbcOperations and update SQL.

Parameters:

jdbcOperations - the JdbcOperations for execution.

updateQuery - the query to execute.

JdbcOutboundGateway

public JdbcOutboundGateway(JdbcOperations jdbcOperations,
 String updateQuery,
 String selectQuery)

Construct an instance based on the provided JdbcOperations, select and update SQLs.

Parameters:

jdbcOperations - the JdbcOperations for execution.

updateQuery - the update to execute.

selectQuery - the select to execute.

Method Details

setMaxRows

public void setMaxRows(Integer maxRows)

The maximum number of rows to query. The value is set on the underlying JdbcPollingChannelAdapter. Also used to check before producing reply: if result has only one item and maxRows is not set or configured to 1, only that item is returned. Otherwise, the whole list. If not specified this value will default to 1. This parameter is only applicable if a selectQuery was provided. Null values are not permitted.

Parameters:

maxRows - the number of rows to select. Must not be null.

Since:

5.1

See Also:

• JdbcPollingChannelAdapter.setMaxRows(int)

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

setRequestSqlParameterSourceFactory

public void setRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

Set a SqlParameterSourceFactory for update query.

Parameters:

sqlParameterSourceFactory - the SqlParameterSourceFactory to use.

setRequestPreparedStatementSetter

public void setRequestPreparedStatementSetter(MessagePreparedStatementSetter requestPreparedStatementSetter)

Set a MessagePreparedStatementSetter for update query.

Parameters:

requestPreparedStatementSetter - the MessagePreparedStatementSetter to use.

setReplySqlParameterSourceFactory

public void setReplySqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

/** Set a SqlParameterSourceFactory for select query.

Parameters:

sqlParameterSourceFactory - the SqlParameterSourceFactory to use.

setRowMapper

public void setRowMapper(RowMapper<?> rowMapper)

Set a select result RowMapper.

Parameters:

rowMapper - the RowMapper to use.

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

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.