org.springframework.integration.jdbc

Class JdbcPollingChannelAdapter

java.lang.Object

org.springframework.integration.util.AbstractExpressionEvaluator

org.springframework.integration.endpoint.AbstractMessageSource<java.lang.Object>

org.springframework.integration.jdbc.JdbcPollingChannelAdapter

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, MessageSource<java.lang.Object>, NamedComponent, IntegrationManagement, MessageSourceMetrics

public class JdbcPollingChannelAdapter
extends AbstractMessageSource<java.lang.Object>

A polling channel adapter that creates messages from the payload returned by executing a select query. Optionally an update can be executed after the select in order to update processed rows.

Since:

2.0

Author:

Jonas Partner, Dave Syer, Artem Bilan

Nested Class Summary

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

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
JdbcPollingChannelAdapter(javax.sql.DataSource dataSource, java.lang.String selectQuery) Constructor taking DataSource from which the DB Connection can be obtained and the select query to execute to retrieve new rows.
JdbcPollingChannelAdapter(org.springframework.jdbc.core.JdbcOperations jdbcOperations, java.lang.String selectQuery) Constructor taking JdbcOperations instance to use for query execution and the select query to execute to retrieve new rows.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<?>	doPoll(org.springframework.jdbc.core.namedparam.SqlParameterSource sqlQueryParameterSource)
protected java.lang.Object	doReceive() Execute the select query and the update query if provided.
java.lang.String	getComponentType()
protected void	onInit()
void	setMaxRows(int maxRows) The maximum number of rows to query.
void	setMaxRowsPerPoll(int maxRows) Deprecated. since 5.1 in favor of setMaxRows(int)
void	setRowMapper(org.springframework.jdbc.core.RowMapper<?> rowMapper)
void	setSelectSqlParameterSource(org.springframework.jdbc.core.namedparam.SqlParameterSource sqlQueryParameterSource) A source of parameters for the select query used for polling.
void	setUpdatePerRow(boolean updatePerRow)
void	setUpdateSql(java.lang.String updateSql)
void	setUpdateSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

Methods inherited from class org.springframework.integration.endpoint.AbstractMessageSource

buildMessage, destroy, getComponentName, getManagedName, getManagedType, getMessageCount, getMessageCountLong, getOverrides, isCountsEnabled, isLoggingEnabled, receive, registerMetricsCaptor, reset, setBeanName, setCountsEnabled, setHeaderExpressions, setLoggingEnabled, setManagedName, setManagedType

Methods inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, setBeanFactory, setConversionService

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcPollingChannelAdapter

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

Constructor taking DataSource from which the DB Connection can be obtained and the select query to execute to retrieve new rows.

Parameters:

dataSource - Must not be null

selectQuery - query to execute

JdbcPollingChannelAdapter

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

Constructor taking JdbcOperations instance to use for query execution and the select query to execute to retrieve new rows.

Parameters:

jdbcOperations - instance to use for query execution

selectQuery - query to execute

Method Detail

setRowMapper

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

setUpdateSql

public void setUpdateSql(java.lang.String updateSql)

setUpdatePerRow

public void setUpdatePerRow(boolean updatePerRow)

setUpdateSqlParameterSourceFactory

public void setUpdateSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

setSelectSqlParameterSource

public void setSelectSqlParameterSource(org.springframework.jdbc.core.namedparam.SqlParameterSource sqlQueryParameterSource)

A source of parameters for the select query used for polling.

Parameters:

sqlQueryParameterSource - the sql query parameter source to set

setMaxRowsPerPoll

@Deprecated
public void setMaxRowsPerPoll(int maxRows)

Deprecated. since 5.1 in favor of setMaxRows(int)

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). Default is zero.

Parameters:

maxRows - the max rows to set

setMaxRows

public void setMaxRows(int maxRows)

The maximum number of rows to query. Default is zero - select all records.

Parameters:

maxRows - the max rows to set

Since:

5.1

onInit

protected void onInit()

Overrides:

onInit in class AbstractExpressionEvaluator

getComponentType

public java.lang.String getComponentType()

doReceive

protected java.lang.Object doReceive()

Execute the select query and the update query if provided. Returns the rows returned by the select query. If a RowMapper has been provided, the mapped results are returned.

Specified by:

doReceive in class AbstractMessageSource<java.lang.Object>

Returns:

The value returned.

doPoll

protected java.util.List<?> doPoll(org.springframework.jdbc.core.namedparam.SqlParameterSource sqlQueryParameterSource)