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<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.DisposableBean,org.springframework.beans.factory.InitializingBean,org.springframework.context.ApplicationContextAware,org.springframework.core.Ordered,org.springframework.integration.context.ExpressionCapable,org.springframework.integration.context.Orderable,org.springframework.integration.core.MessageProducer,org.springframework.integration.handler.HeaderPropagationAware,org.springframework.integration.IntegrationPattern,org.springframework.integration.support.context.NamedComponent,org.springframework.integration.support.management.IntegrationManagement,org.springframework.integration.support.management.TrackableComponent,org.springframework.messaging.MessageHandler,reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>
public class JdbcOutboundGateway
extends org.springframework.integration.handler.AbstractReplyProducingMessageHandler
- Since:
- 2.0
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler
org.springframework.integration.handler.AbstractReplyProducingMessageHandler.RequestHandlerNested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement
org.springframework.integration.support.management.IntegrationManagement.ManagementOverrides -
Field Summary
Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler
messagingTemplateFields inherited from class org.springframework.integration.context.IntegrationObjectSupport
EXPRESSION_PARSER, loggerFields inherited from interface org.springframework.integration.support.management.IntegrationManagement
METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAMEFields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Constructor Summary
ConstructorsConstructorDescriptionJdbcOutboundGateway(DataSource dataSource, String updateQuery) Construct an instance based on the providedDataSourceand update SQL.JdbcOutboundGateway(DataSource dataSource, String updateQuery, String selectQuery) Construct an instance based on the providedDataSource, select and update SQLs.JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations, String updateQuery) Construct an instance based on the providedJdbcOperationsand update SQL.JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations, String updateQuery, String selectQuery) Construct an instance based on the providedJdbcOperations, select and update SQLs. -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddoInit()protected ObjecthandleRequestMessage(org.springframework.messaging.Message<?> requestMessage) voidsetKeysGenerated(boolean keysGenerated) Flag to indicate that the update query is an insert with auto-generated keys, which will be logged at debug level.voidsetMaxRows(Integer maxRows) The maximum number of rows to query.voidsetReplySqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory) /** Set aSqlParameterSourceFactoryfor select query.voidsetRequestPreparedStatementSetter(MessagePreparedStatementSetter requestPreparedStatementSetter) Set aMessagePreparedStatementSetterfor update query.voidsetRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory) Set aSqlParameterSourceFactoryfor update query.voidsetRowMapper(org.springframework.jdbc.core.RowMapper<?> rowMapper) Set a select resultRowMapper.Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler
doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReplyMethods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeadersMethods inherited from class org.springframework.integration.handler.AbstractMessageHandler
handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConventionMethods inherited from class org.springframework.integration.handler.MessageHandlerSupport
buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrackMethods 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, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface reactor.core.CoreSubscriber
currentContextMethods inherited from interface org.springframework.integration.support.management.IntegrationManagement
getThisAsMethods inherited from interface org.springframework.integration.support.context.NamedComponent
getBeanName, getComponentName
-
Constructor Details
-
JdbcOutboundGateway
Construct an instance based on the providedDataSourceand update SQL.- Parameters:
dataSource- theDataSourcefor execution.updateQuery- the query to execute.
-
JdbcOutboundGateway
Construct an instance based on the providedDataSource, select and update SQLs.- Parameters:
dataSource- theDataSourcefor execution.updateQuery- the update to execute.selectQuery- the select to execute.
-
JdbcOutboundGateway
public JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations, String updateQuery) Construct an instance based on the providedJdbcOperationsand update SQL.- Parameters:
jdbcOperations- theJdbcOperationsfor execution.updateQuery- the query to execute.
-
JdbcOutboundGateway
public JdbcOutboundGateway(org.springframework.jdbc.core.JdbcOperations jdbcOperations, String updateQuery, String selectQuery) Construct an instance based on the providedJdbcOperations, select and update SQLs.- Parameters:
jdbcOperations- theJdbcOperationsfor execution.updateQuery- the update to execute.selectQuery- the select to execute.
-
-
Method Details
-
setMaxRows
The maximum number of rows to query. The value is set on the underlyingJdbcPollingChannelAdapter. Also used to check before producing reply: if result has only one item andmaxRowsis not set or configured to1, only that item is returned. Otherwise, the whole list. If not specified this value will default to1. 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:
-
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 aSqlParameterSourceFactoryfor update query.- Parameters:
sqlParameterSourceFactory- theSqlParameterSourceFactoryto use.
-
setRequestPreparedStatementSetter
public void setRequestPreparedStatementSetter(MessagePreparedStatementSetter requestPreparedStatementSetter) Set aMessagePreparedStatementSetterfor update query.- Parameters:
requestPreparedStatementSetter- theMessagePreparedStatementSetterto use.
-
setReplySqlParameterSourceFactory
/** Set aSqlParameterSourceFactoryfor select query.- Parameters:
sqlParameterSourceFactory- theSqlParameterSourceFactoryto use.
-
setRowMapper
public void setRowMapper(org.springframework.jdbc.core.RowMapper<?> rowMapper) Set a select resultRowMapper.- Parameters:
rowMapper- theRowMapperto use.
-
getComponentType
- Specified by:
getComponentTypein interfaceorg.springframework.integration.support.context.NamedComponent- Overrides:
getComponentTypein classorg.springframework.integration.handler.MessageHandlerSupport
-
doInit
protected void doInit()- Overrides:
doInitin classorg.springframework.integration.handler.AbstractReplyProducingMessageHandler
-
handleRequestMessage
- Specified by:
handleRequestMessagein classorg.springframework.integration.handler.AbstractReplyProducingMessageHandler
-