org.springframework.integration.jdbc

Class JdbcOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

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<org.springframework.messaging.Message<?>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>

public class JdbcOutboundGateway
extends AbstractReplyProducingMessageHandler
implements org.springframework.beans.factory.InitializingBean

Since:

2.0

Author:

Dave Syer, Gunnar Hillert, Artem Bilan

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 and Description
JdbcOutboundGateway(javax.sql.DataSource dataSource, java.lang.String updateQuery)
JdbcOutboundGateway(javax.sql.DataSource dataSource, java.lang.String updateQuery, java.lang.String selectQuery)
JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations, java.lang.String updateQuery)
JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations, java.lang.String updateQuery, java.lang.String selectQuery)

Method Summary

Modifier and Type	Method and Description
protected void	doInit()
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
protected java.lang.Object	handleRequestMessage(org.springframework.messaging.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	setMaxRowsPerPoll(java.lang.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	setRequestPreparedStatementSetter(MessagePreparedStatementSetter requestPreparedStatementSetter)
void	setRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)
void	setRowMapper(org.springframework.jdbc.core.RowMapper<?> rowMapper)

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

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

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

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

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

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

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, 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 org.springframework.beans.factory.InitializingBean

afterPropertiesSet

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

getComponentName

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Constructor Detail

JdbcOutboundGateway

public JdbcOutboundGateway(javax.sql.DataSource dataSource,
                           java.lang.String updateQuery)

JdbcOutboundGateway

public JdbcOutboundGateway(javax.sql.DataSource dataSource,
                           java.lang.String updateQuery,
                           java.lang.String selectQuery)

JdbcOutboundGateway

public JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations,
                           java.lang.String updateQuery)

JdbcOutboundGateway

public JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations,
                           java.lang.String updateQuery,
                           java.lang.String selectQuery)

Method Detail

setMaxRowsPerPoll

public void setMaxRowsPerPoll(java.lang.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 1. This parameter is only applicable if a selectQuery was provided. Null values are not permitted.

Parameters:

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

getComponentType

public java.lang.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 java.lang.Object handleRequestMessage(org.springframework.messaging.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 auto-generated keys, which will be logged at debug level.

Parameters:

keysGenerated - the flag value to set

setRequestSqlParameterSourceFactory

public void setRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

setRequestPreparedStatementSetter

public void setRequestPreparedStatementSetter(MessagePreparedStatementSetter requestPreparedStatementSetter)

setReplySqlParameterSourceFactory

public void setReplySqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

setRowMapper

public void setRowMapper(org.springframework.jdbc.core.RowMapper<?> rowMapper)