org.springframework.integration.jdbc

Class JdbcOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.jdbc.JdbcOutboundGateway

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, MessageProducer, TrackableComponent, NamedComponent, MessageHandler

public class JdbcOutboundGateway
extends AbstractReplyProducingMessageHandler
implements InitializingBean

Since:

2.0

Author:

Dave Syer, Gunnar Hillert

Nested Class Summary

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

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
JdbcOutboundGateway(DataSource dataSource, String updateQuery)
JdbcOutboundGateway(DataSource dataSource, String updateQuery, String selectQuery)
JdbcOutboundGateway(JdbcOperations jdbcOperations, String updateQuery)
JdbcOutboundGateway(JdbcOperations jdbcOperations, String updateQuery, String selectQuery)

Method Summary

Methods

Modifier and Type	Method and 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 autogenerated keys, which will be logged at debug level.
void	setMaxRowsPerPoll(Integer maxRowsPerPoll) The maximum number of rows to pull out of the query results per poll (if greater than zero, otherwise all rows will be packed into the outgoing message).
void	setReplySqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)
void	setRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)
void	setRowMapper(RowMapper<?> rowMapper)

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

doInvokeAdvisedRequestHandler, getMessagingTemplate, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setChannelResolver, setOutputChannel, setOutputChannelName, setRequiresReply, setSendTimeout, shouldCopyRequestHeaders

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

getOrder, handleMessage, setOrder, setShouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

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

getComponentName

Constructor Detail

JdbcOutboundGateway

public JdbcOutboundGateway(DataSource dataSource,
                   String updateQuery)

JdbcOutboundGateway

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

JdbcOutboundGateway

public JdbcOutboundGateway(JdbcOperations jdbcOperations,
                   String updateQuery)

JdbcOutboundGateway

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

Method Detail

setMaxRowsPerPoll

public void setMaxRowsPerPoll(Integer maxRowsPerPoll)

The maximum number of rows to pull out of the query results per poll (if greater than zero, otherwise all rows will be packed into the outgoing message). The value is ultimately set on the underlying JdbcPollingChannelAdapter. If not specified this value will default to zero. This parameter is only applicable if a selectQuery was provided. Null values are not permitted.

Parameters:

maxRowsPerPoll - Must not be null.

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 AbstractMessageHandler

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.

setKeysGenerated

public void setKeysGenerated(boolean keysGenerated)

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

Parameters:

keysGenerated - the flag value to set

setRequestSqlParameterSourceFactory

public void setRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

setReplySqlParameterSourceFactory

public void setReplySqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

setRowMapper

public void setRowMapper(RowMapper<?> rowMapper)