org.springframework.integration.jdbc

Class StoredProcPollingChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.jdbc.StoredProcPollingChannelAdapter

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, MessageSource<Object>, NamedComponent

public class StoredProcPollingChannelAdapter
extends IntegrationObjectSupport
implements MessageSource<Object>

A polling channel adapter that creates messages from the payload returned by executing a stored procedure or Sql function. Optionally an update can be executed after the execution of the Stored Procedure or Function in order to update processed rows.

Since:

2.1

Author:

Gunnar Hillert

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
StoredProcPollingChannelAdapter(StoredProcExecutor storedProcExecutor) Constructor taking StoredProcExecutor.

Method Summary

Modifier and Type	Method and Description
protected Map<String,?>	doPoll()
String	getComponentType() Subclasses may implement this method to provide component type information.
Message<Object>	receive() Executes the query.
void	setExpectSingleResult(boolean expectSingleResult) This parameter indicates that only one result object shall be returned from the Stored Procedure/Function Call.

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, onInit, 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

Constructor Detail

StoredProcPollingChannelAdapter

public StoredProcPollingChannelAdapter(StoredProcExecutor storedProcExecutor)

Constructor taking StoredProcExecutor.

Parameters:

storedProcExecutor - Must not be null.

Method Detail

receive

public Message<Object> receive()

Executes the query. If a query result set contains one or more rows, the Message payload will contain either a List of Maps for each row or, if a RowMapper has been provided, the values mapped from those rows. If the query returns no rows, this method will return null.

Specified by:

receive in interface MessageSource<Object>

Returns:

The message or null.

doPoll

protected Map<String,?> doPoll()

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 IntegrationObjectSupport

setExpectSingleResult

public void setExpectSingleResult(boolean expectSingleResult)

This parameter indicates that only one result object shall be returned from the Stored Procedure/Function Call. If set to true, a resultMap that contains only 1 element, will have that 1 element extracted and returned as payload. If the resultMap contains more than 1 element and expectSingleResult is true, then a MessagingException is thrown. Otherwise the complete resultMap is returned as the Message payload. Important Note: Several databases such as H2 are not fully supported. The H2 database, for example, does not fully support the CallableStatement semantics and when executing function calls against H2, a result list is returned rather than a single value. Therefore, even if you set expectSingleResult = true, you may end up with a collection being returned.

Parameters:

expectSingleResult - true if a single result is expected.