Spring Integration Component
The spring-integration: component provides a bridge for Camel components to talk to spring integration endpoints.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-spring-integration</artifactId>
<version>x.x.x</version>
</dependency>
URI format
spring-integration:defaultChannelName[?options]
Where defaultChannelName represents the default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider.
You can append query options to the URI in the following format, ?option=value&option=value&...
Options
Name |
Type |
Description |
inputChannel |
String |
The Spring integration input channel name that this endpoint wants to consume from, where the specified channel name is defined in the Spring context. |
outputChannel |
String |
The Spring integration output channel name that is used to send messages to the Spring integration context. |
inOut |
String |
The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected, either from the Spring Integration Message header or configured on the endpoint. |
Usage
The Spring integration component is a bridge that connects Camel endpoints with Spring integration endpoints through the Spring integration's input channels and output channels. Using this component, we can send Camel messages to Spring Integration endpoints or receive messages from Spring integration endpoints in a Camel routing context.
Examples
Using the Spring integration endpoint
You can set up a Spring integration endpoint using a URI, as follows:
<beans:beans xmlns="http://www.springframework.org/schema/integration"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:beans="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration
http://www.springframework.org/schema/integration/spring-integration.xsd
http://camel.apache.org/schema/spring
http://camel.apache.org/schema/spring/camel-spring.xsd">
<channel id="inputChannel"/>
<channel id="outputChannel"/>
<channel id="onewayChannel"/>
<service-activator input-channel="inputChannel" ref="helloService" method="sayHello"/>
<service-activator input-channel="onewayChannel" ref="helloService" method="greet"/>
<beans:bean id="helloService" class="org.apache.camel.component.spring.integration.HelloWorldService"/>
<camelContext id="camel" xmlns="http://camel.apache.org/schema/spring">
<route>
<from uri="direct:twowayMessage"/>
<to uri="spring-integration:inputChannel?inOut=true&inputChannel=outputChannel"/>
</route>
<route>
<from uri="direct:onewayMessage"/>
<to uri="spring-integration:onewayChannel?inOut=false"/>
</route>
</camelContext>
<channel id="requestChannel"/>
<channel id="responseChannel"/>
<beans:bean id="myProcessor" class="org.apache.camel.component.spring.integration.MyProcessor"/>
<camelContext xmlns="http://camel.apache.org/schema/spring">
<route>
<from uri="spring-integration://requestChannel?outputChannel=responseChannel&inOut=true"/>
<process ref="myProcessor"/>
</route>
</camelContext>
Or directly using a Spring integration channel name:
<beans:beans xmlns="http://www.springframework.org/schema/integration"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:beans="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration
http://www.springframework.org/schema/integration/spring-integration.xsd
http://camel.apache.org/schema/spring
http://camel.apache.org/schema/spring/camel-spring.xsd">
<channel id="outputChannel"/>
<camelContext xmlns="http://camel.apache.org/schema/spring">
<route>
<from uri="outputChannel"/>
<to uri="mock:result"/>
</route>
</camelContext>
The Source and Target adapter
Spring integration also provides the Spring integration's source and target adapters, which can route messages from a Spring integration channel to a Camel endpoint or from a Camel endpoint to a Spring integration channel.
This example uses the following namespaces:
<beans:beans xmlns="http://www.springframework.org/schema/integration"
xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:camel-si="http://camel.apache.org/schema/spring/integration"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration
http://www.springframework.org/schema/integration/spring-integration.xsd
http://camel.apache.org/schema/spring/integration
http://camel.apache.org/schema/spring/integration/camel-spring-integration.xsd
http://camel.apache.org/schema/spring
http://camel.apache.org/schema/spring/camel-spring.xsd
">
You can bind your source or target to a Camel endpoint as follows:
<camelContext id="camelTargetContext" xmlns="http://camel.apache.org/schema/spring">
<route>
<from uri="direct:EndpointA" />
<to uri="mock:result" />
</route>
<route>
<from uri="direct:EndpointC"/>
<process ref="myProcessor"/>
</route>
</camelContext>
<camel-si:camelTarget id="camelTargetA" camelEndpointUri="direct:EndpointA" expectReply="false">
<camel-si:camelContextRef>camelTargetContext</camel-si:camelContextRef>
</camel-si:camelTarget>
<camel-si:camelTarget id="camelTargetB" camelEndpointUri="direct:EndpointC" replyChannel="channelC" expectReply="true">
<camel-si:camelContextRef>camelTargetContext</camel-si:camelContextRef>
</camel-si:camelTarget>
<camel-si:camelTarget id="camelTargetD" camelEndpointUri="direct:EndpointC" expectReply="true">
<camel-si:camelContextRef>camelTargetContext</camel-si:camelContextRef>
</camel-si:camelTarget>
<beans:bean id="myProcessor" class="org.apache.camel.component.spring.integration.MyProcessor"/>
<channel id="channelA"/>
<channel id="channelB"/>
<channel id="channelC"/>
<service-activator input-channel="channelB" output-channel="channelC" ref="helloService" method="sayHello"/>
<beans:bean id="helloService" class="org.apache.camel.component.spring.integration.HelloWorldService"/>
<camelContext id="camelSourceContext" xmlns="http://camel.apache.org/schema/spring">
<route>
<from uri="direct:OneWay"/>
<to uri="direct:EndpointB"/>
</route>
<route>
<from uri="direct:TwoWay"/>
<to uri="direct:EndpointC"/>
</route>
</camelContext>
<camel-si:camelSource id="camelSourceA" camelEndpointUri="direct:EndpointB"
requestChannel="channelA" expectReply="false">
<camel-si:camelContextRef>camelSourceContext</camel-si:camelContextRef>
</camel-si:camelSource>
<!-- camelSource will redirect the message coming for direct:EndpointC to the spring requestChannel channelB
then it will pull the response from channelC and put the response message back to direct:EndpointC -->
<camel-si:camelSource id="camelSourceB" camelEndpointUri="direct:EndpointC"
requestChannel="channelB" replyChannel="channelC" expectReply="true">
<camel-si:camelContextRef>camelSourceContext</camel-si:camelContextRef>
</camel-si:camelSource>
See Also