org.springframework.integration.jpa.inbound

Class JpaPollingChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.jpa.inbound.JpaPollingChannelAdapter

All Implemented Interfaces:

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

public class JpaPollingChannelAdapter
extends IntegrationObjectSupport
implements MessageSource<Object>

Polling message source that produces messages from the result of the provided:

• entityClass
• JpQl Select Query
• Sql Native Query
• JpQl Named Query
• Sql Native Named Query

After the objects have been polled, it also possibly to either: executes an update after the select possibly to updated the state of selected records

• executes an update (per retrieved object or for the entire payload)
• delete the retrieved object

Since:

2.2

Author:

Amol Nayak, Gunnar Hillert

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
JpaPollingChannelAdapter(JpaExecutor jpaExecutor) Constructor taking a JpaExecutor that provide all required JPA functionality.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentType() Subclasses may implement this method to provide component type information.
protected void	onInit() Check for mandatory attributes
Message<Object>	receive() Uses JpaExecutor.poll() to executes the JPA operation.

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

Constructor Detail

JpaPollingChannelAdapter

public JpaPollingChannelAdapter(JpaExecutor jpaExecutor)

Constructor taking a JpaExecutor that provide all required JPA functionality.

Parameters:

jpaExecutor - Must not be null.

Method Detail

onInit

protected void onInit()
               throws Exception

Check for mandatory attributes

Overrides:

onInit in class IntegrationObjectSupport

Throws:

Exception - Any exception.

receive

public Message<Object> receive()

Uses JpaExecutor.poll() to executes the JPA operation. If JpaExecutor.poll() returns null, this method will return null. Otherwise, a new Message is constructed and returned.

Specified by:

receive in interface MessageSource<Object>

Returns:

The messasge or 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 IntegrationObjectSupport