org.springframework.integration.jpa.outbound

Class JpaOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.jpa.outbound.JpaOutboundGateway

All Implemented Interfaces:

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, Orderable, MessageHandler, MessageProducer, TrackableComponent, NamedComponent

public class JpaOutboundGateway
extends AbstractReplyProducingMessageHandler

The Jpa Outbound Gateway will allow you to make outbound operations to either:

• submit (insert, delete) data to a database using JPA
• retrieve (select) data from a database

Depending on the selected OutboundGatewayType, the outbound gateway will use either the JpaExecutor's poll method or its executeOutboundJpaOperation method. In order to initialize the adapter, you must provide a JpaExecutor as constructor.

Since:

2.2

Author:

Gunnar Hillert, Amol Nayak

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

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

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
JpaOutboundGateway(JpaExecutor jpaExecutor) Constructor taking an JpaExecutor that wraps all JPA Operations.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInit()
protected java.lang.Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
void	setGatewayType(OutboundGatewayType gatewayType)
void	setProducesReply(boolean producesReply) If set to 'false', this component will act as an Outbound Channel Adapter.

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

doInvokeAdvisedRequestHandler, getMessagingTemplate, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setChannelResolver, setOutputChannel, setRequiresReply, setSendTimeout, shouldCopyRequestHeaders

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

getComponentType, getOrder, handleMessage, setOrder, setShouldTrack

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

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, 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.integration.support.context.NamedComponent

getComponentName

Constructor Detail

JpaOutboundGateway

public JpaOutboundGateway(JpaExecutor jpaExecutor)

Constructor taking an JpaExecutor that wraps all JPA Operations.

Parameters:

jpaExecutor - Must not be null

Method Detail

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected java.lang.Object handleRequestMessage(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

setGatewayType

public void setGatewayType(OutboundGatewayType gatewayType)

Parameters:

gatewayType -

setProducesReply

public void setProducesReply(boolean producesReply)

If set to 'false', this component will act as an Outbound Channel Adapter. If not explicitly set this property will default to 'true'.

Parameters:

producesReply - Defaults to 'true'.