© 2016 The original authors.

Provides Apache Camel integration with the WildFly Application Server.

The WildFly-Camel subsystem allows you to add Camel Routes as part of the WildFly configuration. Routes can be deployed as part of JavaEE applications. JavaEE components can access the Camel Core API and various Camel Component APIs.

Your Enterprise Integration Solution can be architected as a combination of JavaEE and Camel functionality.

1. Getting Started

This chapter takes you through the first steps of getting WildFly-Camel and provides the initial pointers to get up and running.

Download the Distribution

WildFly Camel is distributed as

  1. WildFly Patch - wildfly-camel-patch

  2. Docker Image - wildflyext/wildfly-camel

Installing the Camel Subsystem

Simply unpack the provided patch into the a supported WildFly installation. For possible WildFly target versions, see the compatibility page.

Standalone Server

In your WildFly home directory run …​

$ bin/standalone.sh -c standalone-camel.xml
...
10:50:02,833 INFO  [org.jboss.as.server] (ServerService Thread Pool -- 31) JBAS018559: Deployed "wildfly-camel.war" (runtime-name : "wildfly-camel.war")
10:50:02,834 INFO  [org.jboss.as.server] (ServerService Thread Pool -- 31) JBAS018559: Deployed "hawtio.war" (runtime-name : "hawtio.war")
10:50:02,848 INFO  [org.jboss.as] (Controller Boot Thread) JBAS015961: Http management interface listening on http://127.0.0.1:9990/management
10:50:02,849 INFO  [org.jboss.as] (Controller Boot Thread) JBAS015951: Admin console listening on http://127.0.0.1:9990
10:50:02,849 INFO  [org.jboss.as] (Controller Boot Thread) JBAS015874: WildFly 8.1.0.Final "Kenny" started in 10804ms

Domain Mode

Similarly, for the WildFly Domain Mode run …​

$ bin/domain.sh -c domain-camel.xml

Enable Camel Subsystem

The patch does not modify existing configuration files. Instead it comes with a number of additional configurations files that end in -camel.xml.

If you should want to add the Camel subsystem to existing configurations you can run the following command.

$ bin/fuseconfig.sh --configs=camel --enable
Processing config for: camel
   Writing 'layers=fuse' to: .../wildfly-9.0.0.CR1/modules/layers.conf
   Enable camel configuration in: .../wildfly-9.0.0.CR1/standalone/configuration/standalone.xml
   Enable camel configuration in: .../wildfly-9.0.0.CR1/standalone/configuration/standalone-full.xml
   Enable camel configuration in: .../wildfly-9.0.0.CR1/standalone/configuration/standalone-full-ha.xml
   Enable camel configuration in: .../wildfly-9.0.0.CR1/standalone/configuration/standalone-ha.xml
   Enable camel configuration in: .../wildfly-9.0.0.CR1/domain/configuration/domain.xml

There are currently three triggers that can be used to enable Camel for a deployment

  1. a deployment that contains a *-camel-context.xml descriptor

  2. a deployment that contains a type annotated with @CamelAware

  3. a deployment that contains a type annotated with @ContextName

Docker Image

The easiest and most portable way to run WildFly-Camel is to use the wildflyext/wildfly-camel distribution.

$ docker run --rm -ti -p 8080:8080 -p 9990:9990 -e WILDFLY_MANAGEMENT_USER=admin -e WILDFLY_MANAGEMENT_PASSWORD=admin wildflyext/wildfly-camel

Maven Archetypes

To get started with writing Camel JEE applications, there are two Maven archetypes that can generate either a Camel Spring XML or Camel CDI application.

To generate a Camel CDI application, run the following from the command line.

mvn archetype:generate -DarchetypeGroupId=org.wildfly.camel.archetypes \
                       -DarchetypeArtifactId=wildfly-camel-archetype-cdi \
                       -DarchetypeVersion=4.7.0 \
                       -DgroupId=com.mycompany \
                       -DartifactId=my-camel-cdi-application

To generate a Camel Spring XML application, run the following from the command line.

mvn archetype:generate -DarchetypeGroupId=org.wildfly.camel.archetypes \
                       -DarchetypeArtifactId=wildfly-camel-archetype-spring \
                       -DarchetypeVersion=4.7.0 \
                       -DgroupId=com.mycompany \
                       -DartifactId=my-camel-spring-application

Instructions on how to build, test and run the project can be found within the generated README files.

2. Compatibility

The WildFly compatibility matrix

10.1.0.Final

4.3, 4.4, 4.5, 4.6, 4.7

10.0.0.Final

4.0, 4.1, 4.2

9.0.2.Final

3.2, 3.3

9.0.1.Final

3.1

9.0.0.CR1

3.0

8.2.0.Final

2.1, 2.2, 2.3

8.1.0.Final

2.0

3. Features

This chapter provides more detailed information about WildFly-Camel features.

Camel Context Definitions

Camel Contexts can be configured in standalone-camel.xml and domain.xml as part of the subsystem definition like this

<subsystem xmlns="urn:jboss:domain:camel:1.0">
   <camelContext id="system-context-1">
     <![CDATA[
     <route>
       <from uri="direct:start"/>
       <transform>
         <simple>Hello #{body}</simple>
       </transform>
     </route>
     ]]>
   </camelContext>
</subsystem>

Camel Context Deployments

Camel contexts can be deployed to WildFly with a -camel-context.xml suffix.

  1. As a standalone XML file

  2. As part of another supported deployment

A deployment may contain multiple -camel-context.xml files.

A deployed Camel context is CDI injectable like this

@Resource(name = "java:jboss/camel/context/mycontext")
CamelContext camelContext;

Management Console

By default, access to management consoles is secured. We therefore need to setup a Management User first.

$ bin/add-user.sh

What type of user do you wish to add?
 a) Management User (mgmt-users.properties)
 b) Application User (application-users.properties)

The Hawt.io console should show the camel context from subsystem configuration.

hawtio camel 01

Arquillian Test Support

The WildFly Camel test suite uses the WildFly Arquillian managed container. This can connect to an already running WildFly instance or alternatively start up a standalone server instance when needed.

A number of test enrichers have been implemented that allow you to have these WildFly Camel specific types injected into your Arquillian test cases.

@ArquillianResource
CamelContextFactory contextFactory;

@ArquillianResource
CamelContextRegistry contextRegistry;

4. Configuration

This chapter details information about the Camel subsytem and deployment configuration.

Camel Subsystem Configuration

The subsystem configuration may contain static system routes

<subsystem xmlns="urn:jboss:domain:camel:1.0">
   <camelContext id="system-context-1">
     <![CDATA[
     <route>
       <from uri="direct:start"/>
       <transform>
         <simple>Hello #{body}</simple>
       </transform>
     </route>
     ]]>
   </camelContext>
</subsystem>

These routes are started automatically.

Camel Deployment Configuration

If you want to fine tune the default configuration of your Camel deployment, you can edit either the WEB-INF/jboss-all.xml or META-INF/jboss-all.xml configuration file in your deployment.

Use a <jboss-camel> XML element within the jboss-all.xml file to control the camel configuration.

Disabling the Camel Subsystem

If you don’t want the camel subsystem to be added into your deployment, set the enabled="false" attribute on the jboss-camel XML element.

Example jboss-all.xml file:

<jboss umlns="urn:jboss:1.0">
  <jboss-camel xmlns="urn:jboss:jboss-camel:1.0" enabled="false"/>
</jboss>

Selecting Components

If you add nested <component> or <component-module> XML elements, then instead of adding the default list of Camel components to your deployment, only the specified components will be added to your deployment.

Example jboss-all.xml file:

<jboss umlns="urn:jboss:1.0">
  <jboss-camel xmlns="urn:jboss:jboss-camel:1.0">
    <component name="camel-ftp"/>
    <component-module name="org.apache.camel.component.rss"/>
  </jboss-camel>
</jboss>

5. JavaEE Integration

This chapter details information about integration points with JavaEE.

5.1. CDI

CDI integration is provided by cdi.

A Context with an associated route can be provided like this

@Startup
@ApplicationScoped
@ContextName("cdi-context")
public class MyRouteBuilder extends RouteBuilder {

    @Override
    public void configure() throws Exception {
    	from("direct:start").transform(body().prepend("Hi"));
    }
}

and consumed like this

@Inject
@ContextName("cdi-context")
private CamelContext camelctx;

5.2. EJB

Management support is provided through the ejb component which integrates with the EJB3 subsystem.

CamelContext camelctx = new DefaultCamelContext();
    camelctx.addRoutes(new RouteBuilder() {
        @Override
        public void configure() throws Exception {
            from("direct:start").to("ejb:java:module/HelloBean");
        }
    });

5.3. JAXB

JAXB support is provided through the Camel JAXB data format.

Camel supports unmarshalling XML data to JAXB annotated classes and marshalling from classes to XML. What follows demonstrates a simple Camel route for marshalling and unmarshalling with the Camel JAXB data format class.

5.3.1. JAXB Annotated class

@XmlRootElement(name = "customer")
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer implements Serializable {

    private String firstName;
    private String lastName;

    public Customer() {
    }

    public Customer(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

5.3.2. JAXB Class XML representation

<customer xmlns="http://org/wildfly/test/jaxb/model/Customer">
    <firstName>John</firstName>
    <lastName>Doe</lastName>
</customer>

5.3.3. Camel JAXB Unmarshalling

WildFlyCamelContext camelctx = contextFactory.createCamelContext(getClass().getClassLoader());

final JaxbDataFormat jaxb = new JaxbDataFormat();
jaxb.setContextPath("org.wildfly.camel.test.jaxb.model");

camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .unmarshal(jaxb);
    }
});
camelctx.start();

ProducerTemplate producer = camelctx.createProducerTemplate();

// Send an XML representation of the customer to the direct:start endpoint
Customer customer = producer.requestBody("direct:start", readCustomerXml(), Customer.class);
Assert.assertEquals("John", customer.getFirstName());
Assert.assertEquals("Doe", customer.getLastName());

5.3.4. Camel JAXB Marshalling

WildFlyCamelContext camelctx = contextFactory.createCamelContext();

final JaxbDataFormat jaxb = new JaxbDataFormat();
jaxb.setContextPath("org.wildfly.camel.test.jaxb.model");

camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .marshal(jaxb);
    }
});
camelctx.start();

ProducerTemplate producer = camelctx.createProducerTemplate();
Customer customer = new Customer("John", "Doe");
String customerXML = producer.requestBody("direct:start", customer, String.class);
Assert.assertEquals(readCustomerXml(), customerXML);

5.4. JAX-RS

JAX-RS support is provided by Camel CXF-RS.

5.4.1. CXF-RS Producer

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:cxf="http://camel.apache.org/schema/cxf"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://camel.apache.org/schema/cxf http://camel.apache.org/schema/cxf/camel-cxf.xsd
        http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">

    <cxf:rsClient id="cxfProducer"
                  address="http://localhost:8080/rest"
                  serviceClass="org.wildfly.camel.examples.cxf.jaxrs.GreetingService" />

    <camelContext id="cxfrs-camel-context" xmlns="http://camel.apache.org/schema/spring">
        <route>
            <from uri="direct:start" />
            <setHeader headerName="operationName">
                <simple>greet</simple>
            </setHeader>
            <setHeader headerName="CamelCxfRsUsingHttpAPI">
                <constant>false</constant>
            </setHeader>
            <to uri="cxfrs:bean:cxfProducer" />
        </route>
    </camelContext>
</beans>

5.4.2. CXF-RS Consumer

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:cxf="http://camel.apache.org/schema/cxf"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://camel.apache.org/schema/cxf http://camel.apache.org/schema/cxf/camel-cxf.xsd
        http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">

    <cxf:rsServer id="cxfConsumer"
                  address="http://localhost:8080/rest"
                  serviceClass="org.wildfly.camel.examples.cxf.jaxrs.GreetingService" />

    <camelContext id="cxfrs-camel-context" xmlns="http://camel.apache.org/schema/spring">
        <route>
            <from uri="cxfrs:bean:cxfConsumer" />
            <setBody>
                <constant>Hello world</constant>
            </setBody>
        </route>
    </camelContext>
</beans>

5.4.3. JAX-RS Consumer with the Camel REST DSL

The Camel REST DSL gives the capability to write Camel routes that act as JAX-RS consumers. The following RouteBuilder class demonstrates this.

@Startup
@ApplicationScoped
@ContextName("rest-camel-context")
public class RestConsumerRouteBuilder extends RouteBuilder {
  @Override
  public void configure() throws Exception {

    // Use the camel-servlet component to provide REST integration
    restConfiguration().component("servlet")
      .contextPath("/rest").port(8080).bindingMode(RestBindingMode.json);

    rest("/customer")
      // GET /rest/customer
      .get()
        .produces(MediaType.APPLICATION_JSON)
        .to("direct:getCustomers")
      // GET /rest/customer/1
      .get("/{id}")
        .produces(MediaType.APPLICATION_JSON)
        .to("direct:getCustomer")
      // POST /rest/customer
      .post()
        .type(Customer.class)
        .to("direct:createCustomer");
      // PUT /rest/customer
      .put()
        .type(Customer.class)
        .to("direct:updateCustomer");
      // DELETE /rest/customer/1
      .delete("/{id}")
        .to("direct:deleteCustomer");
  }
}

Note that the REST DSL configuration starts with restConfiguration().component("servlet").

The WildFly Camel Subsystem only supports the camel-servlet and camel-undertow components for use with the REST DSL. Attempts to configure other components will not work.

By setting the binding mode, Camel can marshal and unmarshal JSON data either by specifying a 'produces()' or 'type()' configuration step.

5.4.4. JAX-RS Consumer with CamelProxy

JAX-RS consumer endpoints can be configured using the CamelProxy. The proxy enables you to proxy a producer sending to an Endpoint by a regular interface. When clients invoke methods on this interface, the proxy performs a request / reply to a specified endpoint.

Below is an example JAX-RS service interface and implementation.

// Service interface
@Path("/customer")
public interface CustomerService {

  @GET
  @Produces(MediaType.APPLICATION_JSON)
  Response getCustomers();

  @PUT
  Response updateCustomer();
}
// Service implementation
public class CustomerServiceImpl implements CustomerService {
  @Inject
  @ContextName("rest-camel-context")
  private CamelContext context;

  @Produce(uri="direct:rest")
  private CustomerService customerServiceProxy;

  @Override
  public Response getCustomers() {
    return customerServiceProxy.getCustomers();
  }

  @Override
  public Response updateCustomer(Customer customer) {
    return customerServiceProxy.updateCustomer(customer);
  }
}

Notice in the above code example that CustomerServiceImpl delegates all method calls to a customerServiceProxy object which has been annotated with @Produce. This annotation is important as it configures a proxy for the direct:rest endpoint against the CustomerService interface. Whenever any of the REST service methods are invoked by clients, the direct:rest camel route is triggered.

The RouteBuilder class implements logic for each REST service method invocation.

from("direct:rest")
  .process(new Processor() {
      @Override
      public void process(Exchange exchange) throws Exception {
        BeanInvocation beanInvocation = exchange.getIn().getBody(BeanInvocation.class);
        String methodName = beanInvocation.getMethod().getName();
      if (methodName.equals("getCustomers")) {
        List<Customer> customers = customerService.findAllCustomers();
        exchange.getOut().setBody(Response.ok(customers).build());
      } else if(methodName.equals("updateCustomer")) {
        Customer updatedCustomer = (Customer) beanInvocation.getArgs()[0];
        customerService.updateCustomer(updatedCustomer);
        exchange.getOut().setBody(Response.ok().build());
      }
    }
});

In the above RouteBuilder a Processor handles REST service method invocations that have been proxied through the direct:rest endpoint. The exchange message body will be an instance of BeanInvocation. This can be used to determine which web service method was invoked and what arguments were passed to it. In this example some simple logic is used to return results to the client based on the name of the method that was called.

5.4.5. Security

Refer to the JAX-RS security section.

5.4.6. Code examples on GitHub

An example Camel CXF application is available on GitHub.

5.5. JAX-WS

WebService support is provided through the cxf component which integrates with the WildFly WebServices subsystem that also uses Apache CXF.

5.5.1. JAX-WS CXF Producer

The following code example uses CXF to consume a web service which has been deployed by the WildFly web services subsystem.

JAX-WS web service

The following simple web service has a simple 'greet' method which will concatenate two string arguments together and return them.

When the WildFly web service subsystem detects classes containing JAX-WS annotations, it bootstraps a CXF endpoint. In this example the service endpoint will be located at http://hostname:port/context-root/greeting.

// Service interface
@WebService(name = "greeting")
public interface GreetingService {
    @WebMethod(operationName = "greet", action = "urn:greet")
    String greet(@WebParam(name = "message") String message, @WebParam(name = "name") String name);
}

// Service implementation
public class GreetingServiceImpl implements GreetingService{
    public String greet(String message, String name) {
        return message + " " + name ;
    }
}
Camel route configuration

This RouteBuilder configures a CXF producer endpoint which will consume the 'greeting' web service defined above. CDI in conjunction with the camel-cdi component is used to bootstrap the RouteBuilder and CamelContext.

@Startup
@ApplicationScoped
@ContextName("cxf-camel-context")
public class CxfRouteBuilder extends RouteBuilder {

    @Override
    public void configure() throws Exception {
        from("direct:start")
        .to("cxf://http://localhost:8080/example-camel-cxf/greeting?serviceClass=" + GreetingService.class.getName());
    }
}

The greeting web service 'greet' requires two parameters. These can be supplied to the above route by way of a ProducerTemplate. The web service method argument values are configured by constructing an object array which is passed as the exchange body.

String message = "Hello"
String name = "Kermit"

ProducerTemplate producer = camelContext.createProducerTemplate();
Object[] serviceParams = new Object[] {message, name};
String result = producer.requestBody("direct:start", serviceParams, String.class);

5.5.2. Camel CXF JAX-WS Consumer

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:cxf="http://camel.apache.org/schema/cxf"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://camel.apache.org/schema/cxf http://camel.apache.org/schema/cxf/camel-cxf.xsd
        http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">

    <cxf:cxfEndpoint id="cxfConsumer"
                     address="http://localhost:8080/webservices/greeting"
                     serviceClass="org.wildfly.camel.examples.cxf.jaxws.GreetingService" />

    <camelContext id="cxfws-camel-context" xmlns="http://camel.apache.org/schema/spring">
        <route>
            <from uri="cxf:bean:cxfConsumer" />
            <to uri="log:ws" />
        </route>
    </camelContext>

</beans>

5.5.3. JAX-WS Consumer with CamelProxy

JAX-WS consumer endpoints can be configured using the CamelProxy. The proxy enables you to proxy a producer sending to an Endpoint by a regular interface. When clients invoke methods on this interface, the proxy performs a request / reply to a specified endpoint.

Below is an example JAX-WS web service interface and implementation.

// Service interface
@WebService(name = "greeting")
public interface GreetingService {
    @WebMethod(operationName = "greet", action = "urn:greet")
    String greet(@WebParam(name = "name") String name);

    @WebMethod(operationName = "greetWithMessage", action = "urn:greetWithMessage")
    String greetWithMessage(@WebParam(name = "message") String message, @WebParam(name = "name") String name);
}
// Service implementation
@WebService(serviceName="greeting", endpointInterface = "org.wildfly.camel.examples.jaxws.GreetingService")
public class GreetingServiceImpl {
    @Produce(uri="direct:start")
    GreetingService greetingService;

    @WebMethod(operationName = "greet")
    public String greet(@WebParam(name = "name") String name) {
        return greetingService.greet(name);
    }

    @WebMethod(operationName = "greetWithMessage")
    public String greetWithMessage(@WebParam(name = "message") String message, @WebParam(name = "name") String name) {
        return greetingService.greetWithMessage(message, name);
    }
}

Notice in the above code example that GreetingServiceImpl delegates all method calls to a greetingService object which has been annotated with @Produce. This annotation is important as it configures a proxy for the direct:start endpoint against the GreetingService interface. Whenever any of the web service methods are invoked by clients, the direct:start camel route is triggered.

The RouteBuilder class implements logic for each web service method invocation.

@Startup
@ApplicationScoped
@ContextName("jaxws-camel-context")
public class JaxwsRouteBuilder extends RouteBuilder {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .process(new Processor() {
            @Override
            public void process(Exchange exchange) throws Exception {
                BeanInvocation beanInvocation = exchange.getIn().getBody(BeanInvocation.class);
                String methodName = beanInvocation.getMethod().getName();

                if(methodName.equals("greet")) {
                    String name = exchange.getIn().getBody(String.class);
                    exchange.getOut().setBody("Hello " + name);
                } else if(methodName.equals("greetWithMessage")) {
                    String message = (String) beanInvocation.getArgs()[0];
                    String name = (String) beanInvocation.getArgs()[1];
                    exchange.getOut().setBody(message + " " + name);
                } else {
                    throw new IllegalStateException("Unknown method invocation " + methodName);
                }
            }
        });
    }

In the above RouteBuilder a Processor handles web service method invocations that have been proxied through the direct:start endpoint. The exchange message body will be an instance of BeanInvocation. This can be used to determine which web service method was invoked and what arguments were passed to it. In this example some simple logic is used to return results to the client based on the name of the method that was called.

5.5.4. Security

Refer to the JAX-WS security section.

5.5.5. Code examples on GitHub

Example JAX-WS applications are available on GitHub.

5.6. JMS

Messaging support is provided through the jms component which integrates with the WildFly Messaging (ActiveMQ Artemis) subsystem.

Integration with other JMS implementations is possible through configuration of vendor specific resource adapters, or if not available, by using the JBoss Generic JMS resource adapter.

5.6.1. WildFly JMS configuration

The WildFly messaging subsystem can be configured from within the standard WildFly XML configuration files, standalone.xml or domain.xml.

For the examples that follow we use the embedded ActiveMQ Artemis in memory instance. We first configure a new JMS queue on the messaging subsystem by adding the following XML configuration to the jms-destinations section.

<jms-queue name="WildFlyCamelQueue">
  <entry name="java:/jms/queue/WildFlyCamelQueue"/>
</jms-queue>

Alternatively you could use a CLI script to add the queue.

$ jms-queue add --queue-address=WildFlyCamelQueue --entries=queue/WildFlyCamelQueue,java:/jms/queue/WildFlyCamelQueue

Or, you could create a messaging-deployment configuration within a custom jms.xml deployment descriptor. See section 'Deployment of -jms.xml files' within the WildFly messaging subsystem documentation for more information.

5.6.2. Camel route configuration

The following JMS producer and consumer examples make use of WildFly’s embedded ActiveMQ Artemis sever to publish and consume messages to and from destinations.

The examples also use CDI in conjunction with the camel-cdi component. JMS ConnectionFactory instances are injected into the Camel RouteBuilder through JNDI lookups.

JMS Producer

The RouteBuilder begins by injecting the DefaultJMSConnectionFactory connection factory from JNDI. If you’re wondering where the connection factory is defined, look at the WildFly XML configuration and you’ll see it is defined within the messaging subsystem.

Next a timer endpoint runs every 10 seconds to send an XML payload to the WildFlyCamelQueue destination that we configured earlier.

@Startup
@ApplicationScoped
@ContextName("jms-camel-context")
public class JmsRouteBuilder extends RouteBuilder {

  @Resource(mappedName = "java:jboss/DefaultJMSConnectionFactory")
  private ConnectionFactory connectionFactory;

  @Override
  public void configure() throws Exception {
    JmsComponent component = new JmsComponent();
    component.setConnectionFactory(connectionFactory);

    getContext().addComponent("jms", component);

    from("timer://sendJMSMessage?fixedRate=true&period=10000")
    .transform(constant("<?xml version='1.0><message><greeting>hello world</greeting></message>"))
    .to("jms:queue:WildFlyCamelQueue")
    .log("JMS Message sent");
  }
}

A log message will be output to the console each time a JMS message is added to the WildFlyCamelQueue destination. To verify that the messages really are being placed onto the queue, we can use the WildFly administration console.

jms queue browse
JMS Consumer

To consume JMS messages the Camel RouteBuilder implementation is similar to the producer example.

As before, the connection factory is discovered from JNDI, injected and set on the JMSComponent instance.

When the JMS endpoint consumes messages from the WildFlyCamelQueue destination, the content is logged to the console.

@Override
public void configure() throws Exception {
  JmsComponent component = new JmsComponent();
  component.setConnectionFactory(connectionFactory);

  getContext().addComponent("jms", component);

  from("jms:queue:WildFlyCamelQueue")
  .to("log:jms?showAll=true");
}
JMS Transactions

To enable Camel JMS routes to participate in JMS transactions, some additional configuration is required. Since camel-jms is built around spring-jms, we need to configure some Spring classes to enable them to work with WildFly’s transaction manager and connection factory. The following code example demonstrates how to use CDI to configure a transactional JMS Camel route.

The camel-jms component requires a transaction manager of type org.springframework.transaction.PlatformTransactionManager. Therefore, we begin by creating a bean extending JtaTransactionManager. Note that the bean is annotated with @Named to allow the bean to be registered within the Camel bean registry. Also note that the WildFly transaction manager and user transaction instances are injected using CDI.

@Named("transactionManager")
public class CdiTransactionManager extends JtaTransactionManager {

  @Resource(mappedName = "java:/TransactionManager")
  private TransactionManager transactionManager;

  @Resource
  private UserTransaction userTransaction;

  @PostConstruct
  public void initTransactionManager() {
    setTransactionManager(transactionManager);
    setUserTransaction(userTransaction);
  }
}

Next we need to declare the transaction policy that we want to use. Again we use the @Named annotation to make the bean available to Camel. The transaction manager is also injected so that a TransactionTemplate can be created with the desired transaction policy. PROPAGATION_REQUIRED in this instance.

@Named("PROPAGATION_REQUIRED")
public class CdiRequiredPolicy extends SpringTransactionPolicy {
  @Inject
  public CdiRequiredPolicy(CdiTransactionManager cdiTransactionManager) {
    super(new TransactionTemplate(cdiTransactionManager,
      new DefaultTransactionDefinition(TransactionDefinition.PROPAGATION_REQUIRED)));
  }
}

Now we can configure our Camel RouteBuilder class and inject the dependencies needed for the Camel JMS component. The WildFly XA connection factory is injected together with the transaction manager we configured earlier.

In this example RouteBuilder, whenever any messages are consumed from queue1, they are routed to another JMS queue named queue2. Messages consumed from queue2 result in JMS transaction being rolled back using the rollback() DSL method. This results in the original message being placed onto the dead letter queue(DLQ).

@Startup
@ApplicationScoped
@ContextName("jms-camel-context")
public class JMSRouteBuilder extends RouteBuilder {

  @Resource(mappedName = "java:/JmsXA")
  private ConnectionFactory connectionFactory;

  @Inject
  CdiTransactionManager transactionManager;

  @Override
  public void configure() throws Exception {
    // Creates a JMS component which supports transactions
    JmsComponent jmsComponent = JmsComponent.jmsComponentTransacted(connectionFactory, transactionManager);
    getContext().addComponent("jms", jmsComponent);

    from("jms:queue:queue1")
      .transacted("PROPAGATION_REQUIRED")
      .to("jms:queue:queue2");

    // Force the transaction to roll back. The message will end up on the WildFly 'DLQ' message queue
    from("jms:queue:queue2")
      .to("log:end")
      .rollback();
  }
Remote JMS destinations

It’s possible for one WildFly instance to send messages to ActiveMQ Artemis destinations configured on another WildFly instance through remote JNDI.

Some additional WildFly configuration is required to achieve this. First an exported JMS queue is configured.

Only JNDI names bound in the java:jboss/exported namespace are considered as candidates for remote clients, so the queue is named appropriately.

Note that the queue must be configured on the WildFly client application server and the WildFly remote server.

<jms-queue name="RemoteQueue">
  <entry name="java:jboss/exported/jms/queues/RemoteQueue"/>
</jms-queue>

Before the client can connect to the remote server, user access credentials need to be configured. On the remote server run the add user utility to create a new application user within the 'guest' group. This example has a user with the name 'admin' and a password of 'secret'.

The RouteBuilder implementation is different to the previous examples. Instead of injecting the connection factory, we need to configure an InitalContext and retrieve it from JNDI ourselves.

The configureInitialContext method creates this InitialContext. Notice that we need to set a provider URL which should reference your remote WildFly instance host name and port number. This example uses the WildFly JMS http-connector, but there are alternatives documented here.

Finally the route is configured to send an XML payload every 10 seconds to the remote destination configured earlier - 'RemoteQueue'.

@Override
public void configure() throws Exception {
  Context initialContext = configureInitialContext();
  ConnectionFactory connectionFactory = (ConnectionFactory) initialContext.lookup("java:jms/RemoteConnectionFactory");

  JmsComponent component = new JmsComponent();
  component.setConnectionFactory(connectionFactory);

  getContext().addComponent("jms", component);

  from("timer://foo?fixedRate=true&period=10000")
  .transform(constant("<?xml version='1.0><message><greeting>hello world</greeting></message>"))
  .to("jms:queue:RemoteQueue?username=admin&password=secret")
  .to("log:jms?showAll=true");
}

private Context configureInitialContext() throws NamingException {
  final Properties env = new Properties();
  env.put(Context.INITIAL_CONTEXT_FACTORY, "org.jboss.naming.remote.client.InitialContextFactory");
  env.put(Context.PROVIDER_URL, System.getProperty(Context.PROVIDER_URL, "http-remoting://my-remote-host:8080"));
  env.put(Context.SECURITY_PRINCIPAL, System.getProperty("username", "admin"));
  env.put(Context.SECURITY_CREDENTIALS, System.getProperty("password", "secret"));
  return new InitialContext(env);
}

5.6.3. Security

Refer to the JMS security section.

5.6.4. Code examples on GitHub

An example camel-jms application is available on GitHub.

5.7. JMX

Management support is provided through the jmx component which integrates with the WildFly JMX subsystem.

CamelContext camelctx = contextFactory.createWildflyCamelContext(getClass().getClassLoader());
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        String host = InetAddress.getLocalHost().getHostName();
        from("jmx:platform?format=raw&objectDomain=org.apache.camel&key.context=" + host + "/system-context-1&key.type=routes&key.name=\"route1\"" +
        "&monitorType=counter&observedAttribute=ExchangesTotal&granularityPeriod=500").
        to("direct:end");
    }
});
camelctx.start();

ConsumerTemplate consumer = camelctx.createConsumerTemplate();
MonitorNotification notifcation = consumer.receiveBody("direct:end", MonitorNotification.class);
Assert.assertEquals("ExchangesTotal", notifcation.getObservedAttribute());

5.8. JNDI

JNDI integration is provided by a WildFly specific CamelContext, which is can be obtained like this

InitialContext inictx = new InitialContext();
CamelContextFactory factory = inictx.lookup("java:jboss/camel/CamelContextFactory");
WildFlyCamelContext camelctx = factory.createCamelContext();

From a WildFlyCamelContext you can obtain a preconfigured Naming Context

Context context = camelctx.getNamingContext();
context.bind("helloBean", new HelloBean());

which can then be referenced from Camel routes.

camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start").beanRef("helloBean");
    }
});
camelctx.start();

5.9. JPA

JPA integration is provided by the Camel JPA component. Camel JPA applications are developed as per normal by providing a persistence.xml configuration file together with some JPA annotated classes.

5.9.1. Example persistence.xml

In this example we use the Wildfly in-memory ExampleDS datasource which is configured within the Wildfly standalone.xml configuration file.

<persistence version="2.0"
    xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">

    <persistence-unit name="camel">
        <jta-data-source>java:jboss/datasources/ExampleDS</jta-data-source>
        <class>org.wildfly.camel.test.jpa.model.Customer</class>
        <properties>
            <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
            <property name="hibernate.show_sql" value="true"/>
        </properties>
    </persistence-unit>

</persistence>

5.9.2. Example JPA entitiy

@Entity
@Table(name = "customer")
public class Customer implements Serializable {
    @Id
    @GeneratedValue
    private Long id;
    private String firstName;
    private String lastName;

    public Customer() {
    }

    public Customer(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    public Long getId() {
        return id;
    }

    public void setId(final Long id) {
        this.id = id;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

5.9.3. Camel JPA endpoint / route configuration

Having configured JPA, you can make use of CDI to inject an EntityManager and UserTransaction instance into your RouteBuilder class or test case:

@PersistenceContext
EntityManager em;

@Inject
UserTransaction userTransaction;

Now to configure the Camel routes and JPA endpoint:

WildFlyCamelContext camelctx = contextFactory.createCamelContext(getClass().getClassLoader());

EntityManagerFactory entityManagerFactory = em.getEntityManagerFactory();

// Configure a transaction manager
JtaTransactionManager transactionManager = new JtaTransactionManager();
transactionManager.setUserTransaction(userTransaction);
transactionManager.afterPropertiesSet();

// Configure the JPA endpoint to use the correct EntityManagerFactory and JtaTransactionManager
final JpaEndpoint jpaEndpoint = new JpaEndpoint();
jpaEndpoint.setCamelContext(camelctx);
jpaEndpoint.setEntityType(Customer.class);
jpaEndpoint.setEntityManagerFactory(entityManagerFactory);
jpaEndpoint.setTransactionManager(transactionManager);

camelctx.addRoutes(new RouteBuilder() {
@Override
public void configure() throws Exception {
    from("direct:start")
    .to(jpaEndpoint);
}
});

camelctx.start();

Finally, we can send a 'Customer' entity to the 'direct:start' endpoint and then query the ExampleDS datasource to verify that a record was saved.

Customer customer = new Customer("John", "Doe");
ProducerTemplate producer = camelctx.createProducerTemplate();
producer.sendBody("direct:start", customer);

// Query the in memory database customer table to verify that a record was saved
CriteriaBuilder criteriaBuilder = em.getCriteriaBuilder();
CriteriaQuery<Long> query = criteriaBuilder.createQuery(Long.class);
query.select(criteriaBuilder.count(query.from(Customer.class)));

long recordCount = em.createQuery(query).getSingleResult();

Assert.assertEquals(1L, recordCount);

6. Camel Components

This chapter details information about supported camel components

6.1. camel-activemq

Camel ActiveMQ integration is provided by the activemq component.

The component can be configured to work with an embedded or external broker. For Wildfly / EAP container managed connection pools and XA-Transaction support, the ActiveMQ Resource Adapter can be configured into the container configuration file.

6.1.1. WildFly ActiveMQ resource adapter configuration

Download the ActiveMQ resource adapter rar file. The following steps outline how to configure the ActiveMQ resource adapter.

1) Make sure your WildFly instance is stopped.

2) Copy the downloaded resource adapter to the relevant WildFly deployment directory. For standalone mode:

cp activemq-rar-5.11.1.rar ${JBOSS_HOME}/standalone/deployments/activemq-rar.rar

3) Configure the WildFly resource adapters subsystem for the ActiveMQ adapter.

<subsystem xmlns="urn:jboss:domain:resource-adapters:2.0">
     <resource-adapters>
         <resource-adapter id="activemq-rar.rar">
             <archive>
                 activemq-rar.rar
             </archive>
             <transaction-support>XATransaction</transaction-support>
             <config-property name="UseInboundSession">
                 false
             </config-property>
             <config-property name="Password">
                 defaultPassword
             </config-property>
             <config-property name="UserName">
                 defaultUser
             </config-property>
             <config-property name="ServerUrl">
                 tcp://localhost:61616?jms.rmIdFromConnectionId=true
             </config-property>
             <connection-definitions>
                 <connection-definition class-name="org.apache.activemq.ra.ActiveMQManagedConnectionFactory" jndi-name="java:/ActiveMQConnectionFactory" enabled="true" pool-name="ConnectionFactory">
                     <xa-pool>
                         <min-pool-size>1</min-pool-size>
                         <max-pool-size>20</max-pool-size>
                         <prefill>false</prefill>
                         <is-same-rm-override>false</is-same-rm-override>
                     </xa-pool>
                 </connection-definition>
             </connection-definitions>
             <admin-objects>
                 <admin-object class-name="org.apache.activemq.command.ActiveMQQueue" jndi-name="java:/queue/HELLOWORLDMDBQueue" use-java-context="true" pool-name="HELLOWORLDMDBQueue">
                     <config-property name="PhysicalName">
                         HELLOWORLDMDBQueue
                     </config-property>
                 </admin-object>
                 <admin-object class-name="org.apache.activemq.command.ActiveMQTopic" jndi-name="java:/topic/HELLOWORLDMDBTopic" use-java-context="true" pool-name="HELLOWORLDMDBTopic">
                     <config-property name="PhysicalName">
                         HELLOWORLDMDBTopic
                     </config-property>
                 </admin-object>
             </admin-objects>
         </resource-adapter>
     </resource-adapters>
 </subsystem>

If your resource adapter archive filename differs from activemq-rar.rar, you must change the content of the archive element in the preceding configuration to match the name of your archive file.

The values of the UserName and Password configuration properties must be chosen to match the credentials of a valid user in the external broker.

You might need to change the value of the ServerUrl configuration property to match the actual hostname and port exposed by the external broker.

4) Start WildFly. If everything is configured correctly, you should see a message within the WildFly server.log like.

13:16:08,412 INFO  [org.jboss.as.connector.deployment] (MSC service thread 1-5) JBAS010406: Registered connection factory java:/AMQConnectionFactory`

6.1.2. Camel route configuration

The following ActiveMQ producer and consumer examples make use of the ActiveMQ embedded broker and the 'vm' transport (thus avoiding the need for an external ActiveMQ broker).

The examples use CDI in conjunction with the camel-cdi component. JMS ConnectionFactory instances are injected into the Camel RouteBuilder through JNDI lookups.

ActiveMQ Producer
@Startup
@ApplicationScoped
@ContextName("activemq-camel-context")
public class ActiveMQRouteBuilder extends RouteBuilder {

  @Override
  public void configure() throws Exception {
    from("timer://sendJMSMessage?fixedRate=true&period=10000")
    .transform(constant("<?xml version='1.0><message><greeting>hello world</greeting></message>"))
    .to("activemq:queue:WildFlyCamelQueue?brokerURL=vm://localhost")
    .log("JMS Message sent");
  }
}

A log message will be output to the console each time a message is added to the WildFlyCamelQueue destination. To verify that the messages really are being placed onto the queue, we can use the ../features/hawtio.md[Hawtio console,window=_blank] provided by the WildFly Camel subsystem.

activemq queue browse
ActiveMQ Consumer

To consume ActiveMQ messages the Camel RouteBuilder implementation is similar to the producer example.

When the ActiveMQ endpoint consumes messages from the WildFlyCamelQueue destination, the content is logged to the console.

@Override
public void configure() throws Exception {
  from("activemq:queue:WildFlyCamelQueue?brokerURL=vm://localhost")
  .to("log:jms?showAll=true");
}
ActiveMQ Transactions
ActiveMQ Resource Adapter Configuration

The ActiveMQ resource adapter is required as we will want to leverage XA transaction support, connection pooling etc.

The XML snippet below shows how the resource adapter is configured within the WildFly server XML configuration. Notice that the ServerURL is set to use an embedded broker. The connection factory is bound to the JNDI name java:/ActiveMQConnectionFactory. This will be looked up in the RouteBuilder example that follows.

Finally, two queues are configured named 'queue1' and 'queue2'.

<subsystem xmlns="urn:jboss:domain:resource-adapters:2.0">
  <resource-adapters>
    <resource-adapter id="activemq-rar.rar">
      ...
      <admin-objects>
        <admin-object class-name="org.apache.activemq.command.ActiveMQQueue" jndi-name="java:/queue/queue1" use-java-context="true" pool-name="queue1pool">
          <config-property name="PhysicalName">queue1</config-property>
        </admin-object>
        <admin-object class-name="org.apache.activemq.command.ActiveMQQueue" jndi-name="java:/queue/queue2" use-java-context="true" pool-name="queue2pool">
          <config-property name="PhysicalName">queue2</config-property>
        </admin-object>
      </admin-objects>
    </resource-adapter>
  </resource-adapters>
</subsystem>
Transaction Manager

The camel-activemq component requires a transaction manager of type org.springframework.transaction.PlatformTransactionManager. Therefore, we begin by creating a bean extending JtaTransactionManager which fulfills this requirement. Note that the bean is annotated with @Named to allow the bean to be registered within the Camel bean registry. Also note that the WildFly transaction manager and user transaction instances are injected using CDI.

@Named("transactionManager")
public class CdiTransactionManager extends JtaTransactionManager {

  @Resource(mappedName = "java:/TransactionManager")
  private TransactionManager transactionManager;

  @Resource
  private UserTransaction userTransaction;

  @PostConstruct
  public void initTransactionManager() {
    setTransactionManager(transactionManager);
    setUserTransaction(userTransaction);
  }
}
Transaction Policy

Next we need to declare the transaction policy that we want to use. Again we use the @Named annotation to make the bean available to Camel. The transaction manager is also injected so that a TransactionTemplate can be created with the desired transaction policy. PROPAGATION_REQUIRED in this instance.

@Named("PROPAGATION_REQUIRED")
public class CdiRequiredPolicy extends SpringTransactionPolicy {
  @Inject
  public CdiRequiredPolicy(CdiTransactionManager cdiTransactionManager) {
    super(new TransactionTemplate(cdiTransactionManager,
      new DefaultTransactionDefinition(TransactionDefinition.PROPAGATION_REQUIRED)));
  }
}
Route Builder

Now we can configure our Camel RouteBuilder class and inject the dependencies needed for the Camel ActiveMQ component. The ActiveMQ connection factory that we configured on the resource adapter configutation is injected together with the transaction manager we configured earlier.

In this example RouteBuilder, whenever any messages are consumed from queue1, they are routed to another JMS queue named queue2. Messages consumed from queue2 result in JMS transaction being rolled back using the rollback() DSL method. This results in the original message being placed onto the dead letter queue(DLQ).

@Startup
@ApplicationScoped
@ContextName("activemq-camel-context")
public class ActiveMQRouteBuilder extends RouteBuilder {

  @Resource(mappedName = "java:/ActiveMQConnectionFactory")
  private ConnectionFactory connectionFactory;

  @Inject
  private CdiTransactionManager transactionManager;

  @Override
  public void configure() throws Exception {
    ActiveMQComponent activeMQComponent = ActiveMQComponent.activeMQComponent();
    activeMQComponent.setTransacted(false);
    activeMQComponent.setConnectionFactory(connectionFactory);
    activeMQComponent.setTransactionManager(transactionManager);

    getContext().addComponent("activemq", activeMQComponent);

      errorHandler(deadLetterChannel("activemq:queue:ActiveMQ.DLQ")
      .useOriginalMessage()
      .maximumRedeliveries(0)
      .redeliveryDelay(1000));

    from("activemq:queue:queue1F
      .transacted("PROPAGATION_REQUIRED")
      .to("activemq:queue:queue2");

    from("activemq:queue:queue2")
      .to("log:end")
      .rollback();
  }
}

6.1.3. Security

Refer to the JMS security section.

6.1.4. Code examples on GitHub

An example camel-activemq application is available on GitHub.

6.2. camel-ahc

The ahc component provides HTTP based endpoints for consuming external HTTP resources (as a client to call external servers using HTTP). The component uses the Async Http Client library.

6.3. camel-ahc-ws

The ahc-ws component provides Websocket based endpoints for a client communicating with external servers over Websocket. The component uses the ahc component that in turn uses the Async Http Client library.

6.4. camel-amqp

The amqp component supports the AMQP 1.0 protocol using the JMS client of the Qpid project.

6.5. camel-atom

Atom feed consumption in Camel is provided by the atom component.

The following example configures an Atom endpoint to consume the recent activity GitHub feed of user 'wildflyext'. The raw content of each feed entry is then written out as a file within directory 'feed/entries'.

CamelContext camelContext = new DefaultCamelContext();
camelContext.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("atom://https://github.com/wildflyext.atom?splitEntries=true")
        .process(new Processor() {
            @Override
            public void process(final Exchange exchange) throws Exception {
                Entry entry = exchange.getIn().getBody(Entry.class);
                exchange.getOut().setBody(entry.getContent());
            }
        })
        .to("file:///feed/entries/");
    }
});

6.6. camel-avro

The avro component provides a dataformat for avro, which allows serialization and deserialization of messages using Apache Avro’s binary dataformat. Moreover, it provides support for Apache Avro’s rpc, by providing producers and consumers endpoint for using avro over netty or http.

6.7. camel-aws-cw

The AWS CloudWatch component allows messages to be sent to an Amazon CloudWatch metrics.

6.8. camel-aws-ddb

The AWS DynamoDB component supports supports storing and retrieving data from/to Amazon’s DynamoDB service.

6.9. camel-aws-ddbstream

The AWS DynamoDB Stream component supports receiving messages from Amazon DynamoDB Stream service.

6.10. camel-aws-ec2

The AWS EC2 component supports create, run, start, stop and terminate AWS EC2 instances.

6.11. camel-aws-kinesis

The AWS CloudWatch component supports receiving messages from and sending messages to Amazon Kinesis service.

6.12. camel-aws-s3

The AWS S3 component supports storing and retrieving objetcs from/to Amazon’s S3 service.

6.13. camel-aws-sdb

The AWS SDB component storing and retrieving data from/to Amazon’s SDB service.

6.14. camel-aws-ses

The AWS Simple Email Service component supports sending emails with from Amazon’s SES service.

6.15. camel-aws-sns

The AWS SNS component allows messages to be sent to an Amazon Simple Notification Topic.

6.16. camel-aws-sqs

The AWS SQS component sending and receiving messages to Amazon’s SQS service.

6.17. camel-aws-swf

The AWS Simple Workflow component supports managing workflows from Amazon’s Simple Workflow service.

6.18. camel-bean-validator

The bean-validator component provides support for message body validation using the Java Bean Validation API.

6.19. camel-bindy

The goal of bindy is to allow the parsing/binding of non-structured data to/from Java Beans that have binding mappings defined with annotations.

Here we have a annotated domain model class

@CsvRecord(separator = ",")
public class Customer {

    @DataField(pos = 1)
    private String firstName;

    @DataField(pos = 2)
    private String lastName;

    ...
}

We can use the BindyCsvDataFormat data format unmarshall CSV data like John,Doe to the domain model.

camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .unmarshal(new BindyCsvDataFormat(Customer.class))
        .to("mock:result");
    }
});
camelctx.start();

6.20. camel-box

The Box component provides access to all of the box.com APIs.

6.21. camel-braintree

The braintree component provides access to Braintree Payments trough through their Java SDK.

BraintreeComponent component = new BraintreeComponent(camelctx);
component.setConfiguration(configuration);
camelctx.addComponent("braintree", component);

camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("timer://braintree?repeatCount=1")
            .to("braintree:clientToken/generate")
            .process(new Processor() {
                @Override
                public void process(Exchange exchange) throws Exception {
                    latch.countDown();
                }})
            .to("mock:result");
    }
});

6.22. camel-cassandra

The cassandra component is an open source NoSQL database designed to handle large amounts on commodity hardware. Like Amazon’s DynamoDB, Cassandra has a peer-to-peer and master-less architecture to avoid single point of failure and garanty high availability. Like Google’s BigTable, Cassandra data is structured using column families which can be accessed through the Thrift RPC API or a SQL-like API called CQL.

6.23. camel-cdi

Covered by CDI.

6.24. camel-coap

The coap component enables you work with the CoAP protocol. The protocol is designed for machine-to-machine (M2M) applications and is suitable for IoT devices.

6.25. camel-context

The context component enables you to create new Camel components from the routes within another Camel context. This can then be treated as a black box, allowing you to refer to the local endpoints within the component from within the other Camel context.

6.26. camel-couchdb

The couchdb component enables you to treat CouchDB instances as a producer or consumer of messages.

6.27. camel-crypto

Secure message exchanges in camel is provided by the crypto component.

With Camel cryptographic endpoints and Java’s Cryptographic extension it is easy to create Digital Signatures for Exchanges. Camel provides a pair of flexible endpoints which get used in concert to create a signature for an exchange in one part of the exchange’s workflow and then verify the signature in a later part of the workflow.

Begin by loading a keystore for binding to JNDI so that camel can discover it from its bean registry.

KeyStore keystore = KeyStore.getInstance(KeyStore.getDefaultType());
InputStream in = getClass().getResourceAsStream("/my-keystore.ks");
keystore.load(in, "my-keystore-password".toCharArray());

Certificate cert = keystore.getCertificate("my-certificate-alias");

KeyStoreParameters keystoreParameters = new KeyStoreParameters();
keystoreParameters.setPassword("my-keystore-password");
keystoreParameters.setResource("./my-keystore.ks");

InitialContext initialContext = new InitialContext();
initialContext.bind("signatureParams", keystoreParameters);
initialContext.bind("keystore", keystore);
initialContext.bind("myPublicKey", cert.getPublicKey());
initialContext.bind("myCert", cert);
initialContext.bind("myPrivateKey", keystore.getKey("my-certificate-alias", "my-keystore-password".toCharArray()));

Finally, a Camel route that signs and verifies an exchange.

CamelContext camelContext = new DefaultCamelContext();
camelContext.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
      from("direct:sign")
      .to("crypto:sign://basic?privateKey=#myPrivateKey")
      .to("direct:verify");
      from("direct:verify")
      .to("crypto:verify://basic?publicKey=#myPublicKey")
      .to("mock:result");
    }
});

6.28. camel-cxf

Covered by JAX-RS and JAX-WS.

6.29. camel-dns

The dns component provides the ability to:

  • Resolve a domain by its ip

  • Lookup information about a domain

  • Run DNS queries

  CamelContext camelctx = new DefaultCamelContext();
  camelctx.addRoutes(new RouteBuilder() {
      @Override
      public void configure() throws Exception {
          from("direct:start")
          .to("dns:lookup");
      }
  });

  ProducerTemplate producer = camelctx.createProducerTemplate();
  Record[] record = producer.requestBodyAndHeader("direct:start", null, DnsConstants.DNS_NAME, "wildfly.org", Record[].class);

6.30. camel-dozer

The dozer component provides the ability to map between Java beans using the Dozer mapping framework. Camel also supports the ability to trigger Dozer mappings as a type converter.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start").convertBodyTo(CustomerB.class);
    }
});

DozerBeanMapperConfiguration mconfig = new DozerBeanMapperConfiguration();
mconfig.setMappingFiles(Arrays.asList(new String[] { "mappings.xml" }));
new DozerTypeConverterLoader(camelctx, mconfig);

6.31. camel-dropbox

The Dropbox component enables you to integrate with the Dropbox API in order to download, upload and manipulate files.

6.32. camel-ejb

Covered by EJB.

6.33. camel-elasticsearch

The elasticsearch component allows you to interface with an ElasticSearch server.

   CamelContext camelContext = new DefaultCamelContext();
   camelContext.addRoutes(new RouteBuilder() {
       @Override
       public void configure() throws Exception {
           from("direct:index")
           .to("elasticsearch://local?operation=INDEX&indexName=twitter&indexType=tweet");
       }
   });

   Map<String, String> indexedData = new HashMap<>();
   indexedData.put("content", "test");

   ProducerTemplate template = camelContext.createProducerTemplate();
   template.sendBody("direct:index", indexedData);

6.34. camel-elsql

The ElSql component enables you to write SQL queries through ElSql.

6.35. camel-exec

The exec component enables you to execute system commands.

6.36. camel-facebook

The Facebook component provides access to all of the Facebook APIs. You will require a valid developer account in order to use it.

6.37. camel-file2

The file component provides access to file systems, allowing files to be processed by any other Camel Components or messages from other components to be saved to disk.

Here is a simple route that prepends the message with 'Hello' and writes the result to a file in WildFly’s data directory.

final String datadir = System.getProperty("jboss.server.data.dir");

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start").transform(body().prepend("Hello ")).
        to("file:" + datadir + "?fileName=camel-file.txt");
    }
});

6.38. camel-freemarker

The freemarker component enables you to use FreeMarker templates in your camel routes.

6.39. camel-ftp

The ftp component provides access to remote file systems over the FTP and SFTP protocols.

CamelContext camelctx = new DefaultCamelContext();
Endpoint endpoint = camelctx.getEndpoint("ftp://localhost:21000/foo?username=admin&password=admin");
camelctx.createProducerTemplate().sendBodyAndHeader(endpoint, "Hello", "CamelFileName", "test.txt");

6.40. camel-git

The git component enables you to interact with Git repositories.

6.41. camel-github

The github component enables you to interact with the GitHub API.

6.42. camel-hl7

The hl7 component is used for working with the HL7 MLLP protocol and HL7 v2 messages using the HAPI library.

final String msg = "MSH|^~\\&|MYSENDER|MYRECEIVER|MYAPPLICATION||200612211200||QRY^A19|1234|P|2.4\r";
final HL7DataFormat format = new HL7DataFormat();

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .marshal(format)
        .unmarshal(format)
        .to("mock:result");
    }
});
camelctx.start();

HapiContext context = new DefaultHapiContext();
Parser p = context.getGenericParser();
Message hapimsg = p.parse(msg);

ProducerTemplate producer = camelctx.createProducerTemplate();
Message result = (Message) producer.requestBody("direct:start", hapimsg);
Assert.assertEquals(hapimsg.toString(), result.toString());

6.43. camel-http4

The http4 component provides HTTP based endpoints for calling external HTTP resources.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .to("http4://somehost:8080/simple/myservlet");
    }
});

For secure communication over SSL/TLS, you can use the https4 endpoint:

to("https4://somehost:443/simple/myservlet");

6.44. camel-hystrix

The hystrix EIP provides integration with Netflix Hystrix to be used as circuit breaker in Camel routes.

6.45. camel-infinispan

This infinispan component allows you to interact with Infinispan distributed data grid / caches.

You can interact with container managed Infinispan caches by referring to their JNDI lookup within your Camel route. For example, to write a cache entry.

  DefaultCamelContext camelctx = new DefaultCamelContext();
  camelctx.addRoutes(new RouteBuilder() {
      @Override
      public void configure() throws Exception {
          from("direct:put")
          .to("infinispan://localhost?cacheContainer=#java:jboss/infinispan/container/myCache&command=PUT");
      }
  });

  Map<String, Object> headers = new HashMap<>();
  headers.put(InfinispanConstants.KEY, "name");
  headers.put(InfinispanConstants.VALUE, "kermit");

  ProducerTemplate template = camelctx.createProducerTemplate();
  template.sendBodyAndHeaders("direct:put", null, headers);

Or you can interact with external Infinispan caches.

  DefaultCamelContext camelctx = new DefaultCamelContext();
  camelctx.addRoutes(new RouteBuilder() {
      @Override
      public void configure() throws Exception {
          from("direct:put")
          .to("infinispan://my.cache.host?command=PUT");
      }
  });

  Map<String, Object> headers = new HashMap<>();
  headers.put(InfinispanConstants.KEY, "name");
  headers.put(InfinispanConstants.VALUE, "kermit");

  ProducerTemplate template = camelctx.createProducerTemplate();
  template.sendBodyAndHeaders("direct:put", null, headers);

6.46. camel-influxdb

The influxdb component enables you to interact with InfluxDB

6.47. camel-irc

The irc component enables you to publish and consume messages from IRC channels.

6.48. camel-jasypt

The jasypt component provides a simplified encryption library which makes encryption and decryption easy. Camel integrates with Jasypt to allow sensitive information in Properties files to be encrypted.

JasyptPropertiesParser jasypt = new JasyptPropertiesParser();
jasypt.setPassword("secret");

PropertiesComponent pc = new PropertiesComponent();
pc.setLocation("classpath:mysecrets.properties");
pc.setPropertiesParser(jasypt);

context.addComponent("properties", pc);

6.49. camel-jaxb

Covered by JAXB.

6.50. camel-jbpm

The jbpm component provides integration with Business Process Management (BPM) Suit jBPM. It uses kie-remote-client API to interact with jBPM instance over REST. The component supports only producer.

6.51. camel-jcache

The jcache component enables you to perform caching operations using JCache (JSR-107) as the Cache Implementation.

6.52. camel-jdbc

The jdbc component provides access to SQL databases via JDBC.

6.53. camel-jgroups

The jgroups component provides reliable multicast communication via the JGroups toolkit.

6.54. camel-jms

Covered by JMS.

6.55. camel-jmx

Covered by JMX.

6.56. camel-jpa

Covered by JPA.

6.57. camel-jsch

The jsch component enables secure file transfer using the SCP protocol.

CamelContext camelctx = new DefaultCamelContext();
Endpoint endpoint = camelctx.getEndpoint("scp://localhost:22/my/directory?username=admin&password=admin");
camelctx.createProducerTemplate().sendBodyAndHeader(endpoint, "Hello", "CamelFileName", "test.txt");

6.58. camel-kafka

The kafka component is used for communicating with Apache Kafka message broker.

6.59. camel-kubernetes

The ldap component provides the capability to integrate with Kubernetes and OpenShift clusters to create, read, update & delete resources.

6.60. camel-ldap

The ldap component provides the capability to perform LDAP queries.

6.61. camel-linkedin

The linkedin component provides access to the LinkedIn REST APIs.

You must have a valid developer account in order to use this component.

6.62. camel-lucene

The lucene component is based on the Apache Lucene project. Apache Lucene is a powerful high-performance, full-featured text search engine library written entirely in Java.

6.63. camel-mail

Interaction with email is provided by the mail component.

By default, Camel will create its own mail session and use this to interact with your mail server. Since WildFly already provides a mail subsystem with all of the relevant support for secure connections, username / password encryption etc, it is recommended to configure your mail sessions within the WildFly configuration and use JNDI to wire them into your Camel endpoints.

6.63.1. WildFly configuration

First we configure the WildFly mail subsystem for our Mail server. This example adds configuration for Google Mail IMAP and SMTP .

An additional mail-session is configured after the 'default' session.

<subsystem xmlns="urn:jboss:domain:mail:2.0">
    <mail-session name="default" jndi-name="java:jboss/mail/Default">
      <smtp-server outbound-socket-binding-ref="mail-smtp"/>
    </mail-session>
    <mail-session debug="true" name="gmail" jndi-name="java:jboss/mail/gmail">
      <smtp-server outbound-socket-binding-ref="mail-gmail-smtp" ssl="true" username="your-username-here" password="your-password-here"/>
      <imap-server outbound-socket-binding-ref="mail-gmail-imap" ssl="true" username="your-username-here" password="your-password-here"/>
    </mail-session>
</subsystem>
Note that we configured `outbound-socket-binding-ref` values of 'mail-gmail-smtp' and 'mail-gmail-imap'. The next step is to configure these socket bindings. Add aditional bindings to the `socket-binding-group` configuration like the following.
<outbound-socket-binding name="mail-gmail-smtp">
  <remote-destination host="smtp.gmail.com" port="465"/>
</outbound-socket-binding>

<outbound-socket-binding name="mail-gmail-imap">
  <remote-destination host="imap.gmail.com" port="993"/>
</outbound-socket-binding>

This configures our mail session to connect to host smtp.gmail.com on port 465 and imap.gmail.com on port 993. If you’re using a different mail host, then this detail will be different.

6.63.2. POP3 Configuration

If you need to configure POP3 sessions, the principals are the same as defined in the examples above.

<!-- Server configuration -->
<pop3-server outbound-socket-binding-ref="mail-pop3" ssl="true" username="your-username-here" password="your-password-here"/>

<!-- Socket binding configuration -->
<outbound-socket-binding name="mail-gmail-imap">
  <remote-destination host="pop3.gmail.com" port="993"/>
</outbound-socket-binding>

6.63.3. Camel route configuration

Mail producer

This example uses the SMTPS protocol, together with CDI in conjunction with the camel-cdi component. The Java mail session that we configured within the WildFly configuration is injected into a Camel RouteBuilder through JNDI.

Route builder SMTPS example

The GMail mail session is injected into a Producer class using the @Resource annotation with a reference to the jndi-name attribute that we previously configured. This allows us to reference the mail session on the camel-mail endpoint configuration.

public class MailSessionProducer {
    @Resource(lookup = "java:jboss/mail/greenmail")
    private Session mailSession;

    @Produces
    @Named
    public Session getMailSession() {
        return mailSession;
    }
}
public class MailRouteBuilder extends RouteBuilder {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .to("smtps://smtp.gmail.com?session=#mailSession");
    }
}

To send an email we can create a ProducerTemplate and send an appropriate body together with the necessary email headers.

Map<String, Object> headers = new HashMap<String, Object>();
headers.put("To", "destination@test.com");
headers.put("From", "sender@example.com");
headers.put("Subject", "Camel on Wildfly rocks");

String body = "Hi,\n\nCamel on Wildfly rocks!.";

ProducerTemplate template = camelContext.createProducerTemplate();
template.sendBodyAndHeaders("direct:start", body, headers);
Mail consumer

To receive email we use an IMAP MailEndpoint. The Camel route configuration looks like the following.

public void configure() throws Exception {
   from("imaps://imap.gmail.com?session=#mailSession")
   .to("log:email");
}

6.63.4. Security

SSL configuration

WildFly can be configured to manage Java mail sessions and their associated transports using SSL / TLS. When configuring mail sessions you can configure SSL or TLS on server types:

  • smtp-server

  • imap-server

  • pop-server

By setting attributes ssl="true" or tls="true".

Securing passwords

Writing passwords in clear text within configuration files is never a good idea for obvious reasons. The WildFly Vault provides tooling to mask sensitive data.

Camel security

Camel endpoint security documentation can be found on the mail component guide. Camel also has a security summary page.

6.63.5. Code examples on GitHub

An example camel-mail application is available on GitHub for you to try out sending / receiving email.

6.64. camel-metrics

The metrics component allows you to define, publish and collect metrics from Camel routes.

from("direct:start")
.to("metric:counter:simple.counter?increment=3")

6.65. camel-mina2

The mina2 component is a transport for working with Apache MINA.

6.66. camel-mllp

The mllp component is specifically designed to handle the nuances of the MLLP protocol and provide the functionality required by Healthcare providers to communicate with other systems using the MLLP protocol. The MLLP component provides a simple configuration URI, automated HL7 acknowledgment generation and automatic acknowledgement interrogation.

6.67. camel-mongodb

The mongodb component provides the capabilty to interact with MongoDB servers.

6.68. camel-mqtt

The mqtt component is used for communicating with MQTT compliant message brokers, like Apache ActiveMQ or Mosquitto.

6.69. camel-mvel

The mvel component allows you to process a message using an MVEL template.

A simple template

Hello @{request.body}

can be used like this

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start").to("mvel:template.mvel");
    }
});
camelctx.start();
ProducerTemplate producer = camelctx.createProducerTemplate();
String result = producer.requestBody("direct:start", "Kermit", String.class);
Assert.assertEquals("Hello Kermit", result);

6.70. camel-mybatis

The mybatis component allows you to query, poll, insert, update and delete data in a relational database using MyBatis.

6.71. camel-nats

The nats component is used for communicating with the NATS messaging platform.

6.72. camel-netty4

Netty client / server support in Camel is provided by the netty4 component.

WildFly 8 and EAP 6.4 are bundled with module libraries supporting the Netty project version 4. Therefore, the standard netty component will not work since it is compatible with Netty version 3 only.

6.72.1. Simple Netty Client / Server Test

CamelContext camelContext = new DefaultCamelContext();

camelContext.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("netty4:tcp://localhost:7666?textline=true")
                .transform(simple("Hello ${body}"))
                .to("direct:end");
    }
});

camelContext.start();

PollingConsumer pollingConsumer = camelContext.getEndpoint("direct:end").createPollingConsumer();
pollingConsumer.start();

Socket socket = new Socket("localhost", 7666);
PrintWriter out = new PrintWriter(socket.getOutputStream(), true);

try {
    out.write("Kermit\n");
} finally {
    out.close();
    socket.close();
}

String result = pollingConsumer.receive().getIn().getBody(String.class);

Assert.assertEquals("Hello Kermit", result);

camelContext.stop();

6.73. camel-ognl

OGNL expression support in Camel is provided by the ognl component.

6.73.1. Simple Camel OGNL Use Case

CamelContext camelContext = new DefaultCamelContext();
camelContext.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
            .choice()
                .when()
                    .ognl("request.body.name == 'Kermit'").transform(simple("Hello ${body.name}"))
                .otherwise()
                    .to("mock:dlq");
    }
});

camelContext.start();

Person person = new Person();
person.setName("Kermit");

ProducerTemplate producer = camelContext.createProducerTemplate();
String result = producer.requestBody("direct:start", person, String.class);

Assert.assertEquals("Hello Kermit", result);

camelContext.stop();

6.74. camel-olingo2

The olingo2 component provides the capability to interact with OData 2.0 and 3.0 compliant services via Apache Olingo.

6.75. camel-optaplanner

The camel-optaplanner component solves the planning problem contained in a message with OptaPlanner.

6.76. camel-paho

The paho component provides connector for the MQTT messaging protocol using the Eclipse Paho library.

6.77. camel-pdf

The pdf component provides the ability to create, modify or extract content from PDF documents. This component uses Apache PDFBox as underlying library to work with PDF documents.

6.78. camel-quartz2

The quartz component provides a scheduled delivery of messages using the Quartz Scheduler 2.x.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    public void configure() throws Exception {
        from("quartz2://mytimer?trigger.repeatCount=3&trigger.repeatInterval=100")
        .process(new Processor() {
			public void process(Exchange exchange) throws Exception {
				latch.countDown();
			}})
        .to("mock:result");
    }
});

6.79. camel-rabbitmq

The rabbitmq component enables you to produce and consume messages from RabbitMQ instances.

6.80. camel-reactive-streams

The reactive-streams component enables you to exchange messages with reactive stream processing libraries that are compatible with the reactive streams standard.

6.81. camel-rest

The rest component allows you to define REST endpoints using the Rest DSL and plugin to other Camel components as the REST transport.

The WildFly Camel Subsystem only supports the camel-servlet and camel-undertow components for use with the REST DSL. Attempts to configure other components will not work.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        restConfiguration().component("servlet").contextPath("camel/rest").port(8080);
        rest("/hello").get("/{name}").to("direct:hello");
        from("direct:hello").transform(simple("Hello ${header.name}"));
    }
});

6.82. camel-rest-swagger

The rest-swagger component can configure REST producers from a Swagger document and delegate to a component implementing the RestProducerFactory interface such as:

6.83. camel-rss

The rss component is used for polling RSS feeds.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    public void configure() throws Exception {
        from("rss://https://developer.jboss.org/blogs/feeds/posts?splitEntries=true&consumer.initialDelay=200&consumer.delay=1000")
        .process(new Processor() {
			public void process(Exchange exchange) throws Exception {
				latch.countDown();
			}})
        .to("mock:result");
    }
});

6.84. camel-salesforce

The salesforce component provides producer and consumer endpoints to communicate with Salesforce.

In order to use the component, you will need a valid Salesforce account together with credentials for accessing the Salesforce API:

  • Client ID

  • Client Secret

  • Password

  • Username

You’ll want to generate the necessary Salesforce DTO objects before starting. This can be automated with the Camel Salesforce Maven plugin.

mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.clientSecret=<clientsecret> -DcamelSalesforce.userName=<username> -DcamelSalesforce.password=<password>

This example queries Salesforce 'Opportunity' objects.

SalesforceLoginConfig loginConfig = new SalesforceLoginConfig();
loginConfig.setClientId("your-client-id");
loginConfig.setPassword("your-password");
loginConfig.setClientSecret("your-client-secret");
loginConfig.setUserName("your-username");

SalesforceComponent component = new SalesforceComponent();
// The package path to the generated DTO classes
component.setPackages("org.wildfly.camel.test.salesforce.dto");
component.setLoginConfig(loginConfig);

CamelContext camelctx = new DefaultCamelContext();
camelctx.addComponent("salesforce",  component);
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:query")
        .to("salesforce:query?sObjectQuery=SELECT id,name from Opportunity&sObjectClass=" + QueryRecordsOpportunity.class.getName())
        .to("log:salesforce?showAll=true");
    }
});

camelctx.start();

ProducerTemplate producer = ctx.createProducerTemplate();
QueryRecordsOpportunity queryRecords = producer.requestBody("direct:query", null, QueryRecordsOpportunity.class);

6.85. camel-sap

sap is a package consisting of ten different SAP components.

There are remote function call (RFC) components that support the sRFC, tRFC, and qRFC protocols; and there are IDoc components that facilitate communication using messages in IDoc format. The component uses the SAP Java Connector (SAP JCo) library to facilitate bidirectional communication with SAP and the SAP IDoc library to facilitate the transmission of documents in the Intermediate Document (IDoc) format.

A prerequisite for using the Camel SAP component is that the SAP Java Connector (SAP JCo) libraries and the SAP IDoc library are available for the WildFly Camel Subsytem to use. The subsystem distribution does not include these libraries. You will need access to the SAP Service Marketplace in order to obtain them.

6.85.1. Configuring the camel-sap module

Before using camel-sap, an additional WildFly / EAP modules needs to be configured so that the subsystem can discover the new functionality.

Your application server should be stopped before making the following changes.

Modify module com.sap.conn.jco

Download the SAP JCo libraries and the SAP IDoc library from the SAP Service Marketplace, making sure to choose the appropriate library versions for your operating system.

  1. From a terminal session, change into the application server installation root directory

  2. Change into directory modules/system/layers/fuse

  3. Copy sapjco3.jar and sapidoc3.jar into com/sap/conn/jco/main

  4. Create an appropriate native library directory within com/sap/conn/jco/main. For example, if your target platform is Linux x86_64 you would create lib/linux-x86_64. For information relating to other operating systems and architectures see the WildFly Native Libraries documentation

  5. Copy the JCO native library (i.e the .so, .dll or .jnilib file) into the native library directory you created in the previous step

The file and directory structure for module com.sap.conn.jco should now look something like this:

com/sap/conn/jco
com/sap/conn/jco/main
com/sap/conn/jco/main/sapidoc3.jar
com/sap/conn/jco/main/sapjco3.jar
com/sap/conn/jco/main/module.xml
com/sap/conn/jco/main/lib
com/sap/conn/jco/main/lib/linux-x86_64
com/sap/conn/jco/main/lib/linux-x86_64/libsapjco3.so
Activate camel-sap component module
  1. From a terminal session change into the application server installation root directory

  2. Change into directory modules/system/layers/fuse/org/wildfly/camel/extras/main

  3. Edit module.xml and uncomment the org.fusesource.camel.component.sap module dependency. Save the modifed file when finished

The module definition should look like this:

<module xmlns="urn:jboss:module:1.1" name="org.wildfly.camel.extras">
    <dependencies>
        <module name="org.fusesource.camel.component.sap" export="true" services="export" />
    </dependencies>
</module>

Start your application server and camel-sap will be available for use.

6.85.2. Example SAP Camel Route

This example uses XML files containing serialized SAP requests to query Customer records in the Flight Data Application within SAP.

These files are consumed by Camel and their contents are then converted to string message bodies. These messages are then routed to an sap-srfc-destination endpoint which converts and sends them to SAP as BAPI_FLCUST_GETLIST requests to query Customer records.

First we configure a destination data store.

DestinationData destinationData = new DestinationDataImpl();
destinationData.setAshost("example.com");
destinationData.setSysnr("00");
destinationData.setClient("000");
destinationData.setUser("user");
destinationData.setPasswd("password");
destinationData.setLang("en");

Map<String, DestinationData> destinationDataStore = new HashMap<>();
destinationDataStore.put("quickstartDest", destinationData);

Next wire the destinationDataStore into a SapConnectionConfiguration.

SapConnectionConfiguration configuration = new SapConnectionConfiguration();
configuration.setDestinationDataStore(destinationDataStore);

The Camel RouteBuilder looks like this.

@ApplicationScoped
@ContextName("camel-sap-cdi-context")
@Startup
public class SAPRouteBuilder extends RouteBuilder {
    @Override
    public void configure() throws Exception {
      from("file:src/data")
      .convertBodyTo(String.class)
      .to("log:sap?showAll=true")
      .to("sap-srfc-destination:quickstartDest:BAPI_FLCUST_GETLIST")
      .to("log:sap?showAll=true");
    }
}

The XML request looks like the following and is consumed from a file within src/data.

<?xml version="1.0" encoding="ASCII"?>
<!-- NOTE: Replace 'XXX' with the SID of your SAP instance -->
<BAPI_FLCUST_GETLIST:Request xmlns:BAPI_FLCUST_GETLIST="http://sap.fusesource.org/rfc/XXX/BAPI_FLCUST_GETLIST" CUSTOMER_NAME="*" MAX_ROWS="10" WEB_USER="*"/>

When the Camel route runs, the request XML data is consumed from src/data and sent to SAP as a BAPI_FLCUST_GETLIST request. The results of the SAP request are output to the console. You should see an XML structure like the following containing customer records.

<BAPI_FLCUST_GETLIST:Response xmlns:BAPI_FLCUST_GETLIST="http://sap.fusesource.org/rfc/JBF/BAPI_FLCUST_GETLIST">
<CUSTOMER_LIST>
    <row CUSTOMERID="00004715" CUSTNAME="Fred Flintstone" FORM="Mr." STREET="123 Flintstone Lane" POBOX="" POSTCODE="01234" CITY="Bedrock" COUNTR="US" COUNTR_ISO="US" REGION="" PHONE="800-555-1212" EMAIL=""/>
    <row CUSTOMERID="00004716" CUSTNAME="Wilma Flintstone" FORM="Mr." STREET="123 Flintstone Lane" POBOX="" POSTCODE="01234" CITY="Bedrock" COUNTR="US" COUNTR_ISO="US" REGION="" PHONE="800-555-1212" EMAIL=""/>
</CUSTOMER_LIST>
<CUSTOMER_RANGE/>
<EXTENSION_IN/>
<EXTENSION_OUT/>
<RETURN>
    <row TYPE="S" ID="BC_IBF" NUMBER="000" MESSAGE="Method was executed successfully" LOG_NO="" LOG_MSG_NO="000000" MESSAGE_V1="" MESSAGE_V2="" MESSAGE_V3="" MESSAGE_V4="" PARAMETER="" FIELD="" SYSTEM="DEVQKCLNT"/>
</RETURN>
</BAPI_FLCUST_GETLIST:Response>

6.85.3. Further Reading

The example above only scratches the surface of the functionality provided by the camel-sap component. For comprehensive component documentation visit the Camel SAP Component Reference.

6.86. camel-sap-netweaver

The sap-netweaver component integrates with the SAP Gateway.

You will need a valid SAP account in order to use this component. You can sign up here.

6.87. camel-saxon

The saxon component supports XQuery to allow an Expression or Predicate to be used in the DSL or Xml Configuration.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        Namespaces ns = new Namespaces("ns", "http://org/wildfly/test/jaxb/model/Customer");
        from("direct:start").transform().xquery("/ns:customer/ns:firstName", String.class, ns)
        .to("mock:result");
    }
});

6.88. camel-schematron

The schematron component utilises Schematron to make assertions about the presence or absence of patterns in XML documents.

6.89. camel-script

The script component supports a number of scripting languages which can be used to create an Expression or Predicate via the standard JSR 223

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start").choice()
        .when(script("beanshell", "request.getHeaders().get(\"foo\").equals(\"bar\")")).to("mock:result")
        .otherwise().transform(body().append(" unmatched")).to("mock:unmatched");
    }
});

6.90. camel-servicenow

The servicenow component provides access to the ServiceNow REST APIs.

6.91. camel-servlet

The servlet component provides HTTP based endpoints for consuming HTTP requests that arrive at a HTTP endpoint that is bound to a published Servlet.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("servlet://hello?servletName=CamelServletTest&matchOnUriPrefix=true")
        .process(new Processor() {
            @Override
            public void process(Exchange exchange) throws Exception {
                exchange.getOut().setBody("Hello Kermit");
            }
        });
    }
});

6.92. camel-smpp

The smpp component enables SMSC over the SMPP protocol in order to send and receive SMS.

6.93. camel-snmp

The snmp component enables you to poll SNMP enabled devices or configure an SNMP trap.

6.94. camel-spring

Camel contexts can be configured with Spring via the spring component.

6.94.1. Camel Spring XML example

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">

    <camelContext id="hello-camel-context" xmlns="http://camel.apache.org/schema/spring">
        <route>
            <from uri="timer:hello?period=5000" />
            <log message="Hello world" />
        </route>
    </camelContext>

</beans>

6.94.2. Deployment

Spring Camel contexts can be deployed either as part of the camel subsystem configuration or by deploying a '-camel-context.xml' suffixed file.

For more information see the features.

6.95. camel-spring-batch

The spring-batch component and support classes provide integration bridge between Camel and Spring Batch infrastructure.

6.96. camel-spring-integration

The spring-integration component provides a bridge for Camel components to talk to spring integration endpoints.

6.97. camel-spring-ldap

The spring-ldap component provides a Camel wrapper for Spring LDAP.

6.98. camel-spring-redis

The spring-redis component allows sending and receiving messages from Redis. Redis is advanced key-value store where keys can contain strings, hashes, lists, sets and sorted sets. In addition it provides pub/sub functionality for inter-app communications.

Camel provides a producer for executing commands, consumer for subscribing to pub/sub messages an idempotent repository for filtering out duplicate messages.

6.99. camel-sjms

The sjms component, or SJMS, is a JMS client for use with Camel that uses well known best practices when it comes to JMS client creation and configuration.

6.100. camel-sjms-batch

The sjms-batch SJMS Batch component is a specialized component for highly performant, transactional batch consumption from a JMS queue.

6.101. camel-sjms2

The sjms2 component, or SJMS2, is a JMS 2.x client for use with Camel that uses well known best practices when it comes to JMS client creation and configuration.

6.102. camel-splunk

The splunk component provides access to Splunk, via the Splunk provided client Rest API, allowing you to publish and search for events in Splunk.

6.103. camel-sql

The sql component allows you to work with databases using JDBC queries. The difference between this component and JDBC component is that in case of SQL the query is a property of the endpoint and it uses message payload as parameters passed to the query.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("sql:select name from information_schema.users?dataSource=java:jboss/datasources/ExampleDS")
        .to("direct:end");
    }
});

The JNDI datasource lookup shown above works only when configuring a DefaultCamelContext. See below for CdiCamelContext and SpringCamelContext examples.

When used in conjunction with the camel-cdi component, Java EE annotations can make a datasource available to Camel. This example uses the @Named annotation so that Camel can discover the desired datasource.

public class DatasourceProducer {
    @Resource(name = "java:jboss/datasources/ExampleDS")
    DataSource dataSource;

    @Produces
    @Named("wildFlyExampleDS")
    public DataSource getDataSource() {
        return dataSource;
    }
}

Now the datasource can be referenced through the dataSource parameter on the camel-sql endpoint configuration.

@ApplicationScoped
@ContextName("camel-sql-cdi-context")
@Startup
public class CdiRouteBuilder extends RouteBuilder {
    @Override
    public void configure() throws Exception {
        from("sql:select name from information_schema.users?dataSource=wildFlyExampleDS")
        .to("direct:end");
    }
}

When using camel-spring the route configuration would look like:

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jee="http://www.springframework.org/schema/jee"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
       http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd
       http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee.xsd">

    <jee:jndi-lookup id="wildFlyExampleDS" jndi-name="java:jboss/datasources/ExampleDS"/>

    <camelContext id="sql-spring-context" xmlns="http://camel.apache.org/schema/spring">
        <route>
            <from uri="sql:select name from information_schema.users?dataSource=#wildFlyExampleDS" />
            <to uru="direct:end" />
        </route>
    </camelContext>

</beans>

6.103.1. Spring JDBC XML namespace support

Support for the following Spring JDBC XML configurations is supported

jdbc:embedded-database

<jdbc:embedded-database id="datasource" type="H2">
  <jdbc:script location="db-schema.sql"/>
</jdbc:embedded-database>

Only H2 databases are supported by default as WildFly has native support for this. If you want to use other embedded database providers, you will need to install the appropriate database driver.

jdbc:initialize-database

<jdbc:initialize-database data-source="datasource">
  <jdbc:script location="classpath:db-init.sql"/>
</jdbc:initialize-database>

6.104. camel-ssh

The ssh component provides the capability to interact with SSH servers.

6.105. camel-stax

The StAX component enables messages to be passed through a SAX ContentHandler. It can also iterate over JAXB records using StAX.

6.106. camel-stream

The stream component provides access to the System.in, System.out and System.err streams as well as allowing streaming of file and URL.

6.107. camel-swagger

The swagger module is used for exposing the REST services and their APIs using Swagger.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        restConfiguration().component("servlet").contextPath("swagger-tests/rest").port(8080);
        rest("/hello").get("/{name}").to("direct:hello");
        from("direct:hello").transform(simple("Hello ${header.name}"));
    }
});
camelctx.start();

6.108. camel-twitter

The twitter component provides the capability to interact with the Twitter API in order to create and consume tweets, timelines, users, trends, and direct messages.

6.109. camel-undertow

The undertow component provides HTTP-based endpoints for consuming and producing HTTP requests. That is, the Undertow component behaves as a simple Web server. Undertow can also be used as a http client which mean you can also use it with Camel as a producer.

The Undertow component integrates with the Undertow server provided by WildFly.

6.110. camel-velocity

The velocity component allows you to process a message using an Apache Velocity template.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start").to("velocity:" + VELOCITY_TEMPLATE);
    }
});
camelctx.start();

6.111. camel-vertx

The vertx component is for working with the Vertx EventBus. The Vertx EventBus sends and receives JSON events.

6.112. camel-weather

The weather component provides integration with the Open Weather Map API.

As an example, we can consume the current weather for Madrid in Spain and make some decisions based upon the humidity percentage:

CamelContext camelContext = new DefaultCamelContext();
camelContext.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("weather:foo?location=Madrid,Spain")
        .choice()
          .when().jsonpath("$..[?(@humidity > 90)]")
            .to("direct:veryhumid")
          .when().jsonpath("$..[?(@humidity > 70)]")
            .to("direct:humid")
          .otherwise()
            .to("direct:nothumid");
    }
});
camelContext.start();

6.113. camel-xstream

The xstream component provides the XStream Data Format which uses the XStream library to marshal and unmarshal Java objects to and from XML.

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .marshal().xstream();
    }
});

camelctx.start();
try {
    ProducerTemplate producer = camelctx.createProducerTemplate();
    String customer = producer.requestBody("direct:start", new Customer("John", "Doe"), String.class);
} finally {
    camelctx.stop();
}

6.114. camel-zipkin

The camel-zipkin component is used for tracing and timing incoming and outgoing Camel messages using zipkin. Events are captured for incoming and outgoing messages being sent to/from Camel.

6.115. camel-zookeeper

The zookeeper component allows interaction with a ZooKeeper cluster and exposes the following features to Camel:

  • Creation of nodes in any of the ZooKeeper create modes.

  • Get and Set the data contents of arbitrary cluster nodes.

  • Create and retrieve the list the child nodes.

  • A Distributed RoutePolicy that leverages a Leader election.

6.116. Adding Components

Adding support for additional Camel Components is easy

Add your modules.xml definition

A modules.xml descriptor defines the class loading behavior for your component. It should be placed together with the component’s jar in modules/system/layers/fuse/org/apache/camel/component. Module dependencies should be setup for direct compile time dependencies.

Here is an example for the camel-ftp component

<module xmlns="urn:jboss:module:1.1" name="org.apache.camel.component.ftp">
  <resources>
    <resource-root path="camel-ftp-2.14.0.jar" />
  </resources>
  <dependencies>
    <module name="com.jcraft.jsch" />
    <module name="javax.xml.bind.api" />
    <module name="org.apache.camel.core" />
    <module name="org.apache.commons.net" />
  </dependencies>
</module>

Please make sure you don’t duplicate modules that are already available in WildFly and can be reused.

Add a reference to the component

To make this module visible by default to arbitrary JavaEE deployments add a reference to modules/system/layers/fuse/org/apache/camel/component/main/module.xml

<module xmlns="urn:jboss:module:1.3" name="org.apache.camel.component">
  <dependencies>
    ...
    <module name="org.apache.camel.component.ftp" export="true" services="export"/>
  </dependencies>
</module>

7. Data Formats

8. Languages

The following lists supported scripting languages

9. Cloud Integration

This chapter details information about cloud integration

9.1. OpenShift Local

Here we follow the instructions on Try Origin. We use the All-In-One VM approach through Minishift on VirtualBox VM.

After having installed Minishift and VirtualBox, we run:

$ minishift start --vm-driver=virtualbox --memory 12048 --cpus 3
...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.99.100:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

9.1.1. Client Tools

The client tools are available from the Minishift installation.

$ export PATH=$PATH:~/.minishift/cache/oc/v1.4.1

9.1.2. Docker access

When running OpenShift in a single VM, it is recommended to reuse the Docker daemon which Minishift uses for pure Docker use-cases as well. By using the same docker daemon as Minishift, you can speed up your local experiments.

To be able to work with the docker daemon on your Mac or GNU/Linux host use the docker-env command in your shell:

$ eval $(minishift docker-env)

You should now be able to use docker on the command line of your host, talking to the docker daemon inside the Minishift VM:

$ docker ps

9.1.3. Running WildFly-Camel

With every WildFly-Camel release we also publish the latest wildflyext/wildfly-camel image.

You can run the standalone container like this

$ docker run --rm -ti -e WILDFLY_MANAGEMENT_USER=admin -e WILDFLY_MANAGEMENT_PASSWORD=admin -p 8080:8080 -p 9990:9990 wildflyext/wildfly-camel

and access the admin console like this: http://192.168.99.100:9990/console

console standalone

9.1.4. Create an OpenShift project

Here we run a set of WildFly Camel servers on OpenShift Origin. The target platform is the local OpenShift instance that we created above.

example rest design

The example architecture consists of a set of three high available (HA) servers running REST endpoints. For server replication and failover we use Kubernetes. Each server runs in a dedicated Pod that we access via Services.

A project allows us to create deployments, pods, services, routes, etc. under our own custom 'wildfly-camel' namespace.

$ oc login -u user -p user
$ oc new-project wildfly-camel
Create a new application

Now, lets create a new appliction from an existing wildfly-camel based image.

$ oc new-app wildflyext/example-camel-rest

and scale it up

$ oc scale --replicas=3 dc example-camel-rest

After a while you should see the pod running

openshift standalone pods

The pods running the JAX-RS endpoints are however not yet exposed to the world.

Exposing the container externally

Now, lets expose the HTTP root context of the running wildlfy server.

$ oc expose service example-camel-rest

From a remote client, you should now be able to access the service like this

Hello Kermit from 172.17.0.8

9.2. OpenShift on EC2

Here we follow the instructions on Try Origin for binary releases VM.

After having launched an instance of RHEL7 on EC2 we can ssh into the box.

$ ssh -i ~/.ssh/id_rsa_ec2.pem ec2-user@1.2.3.4

9.2.1. Install Docker

Then we install Docker and add the ec2-user to the docker group.

$ curl -fsSL https://get.docker.com/ | sh
$ sudo usermod -aG docker ec2-user
$ sudo systemctl enable docker.service
$ sudo systemctl start docker
$ docker run hello-world
...
Hello from Docker!
This message shows that your installation appears to be working correctly.

9.2.2. Download & Install OpenShift

Now download the OpenShift server and start it

$ curl -L https://github.com/openshift/origin/releases/download/v1.4.0-rc1/openshift-origin-server-v1.4.0-rc1.b4e0954-linux-64bit.tar.gz > openshift-origin-server-v1.4.0-rc1.tar.gz
$ tar xzf openshift-origin-server-v1.4.0-rc1.tar.gz
$ oc cluster up --public-hostname=ec2-1-2-3-4.eu-west-1.compute.amazonaws.com --routing-suffix=1.2.3.4.xip.io

If you see a failure during startup like this, follow the instructions below for Docker deamon configuration.

-- Checking Docker daemon configuration ... FAIL
   Error: did not detect an --insecure-registry argument on the Docker daemon
   Solution:

     Ensure that the Docker daemon is running with the following argument:
     	--insecure-registry 172.30.0.0/16

9.2.3. Registry Security

The Docker registry may need to be marked as insecure.

  1. Create the /etc/systemd/system/docker.service.d directory.

    $ sudo mkdir /etc/systemd/system/docker.service.d
  2. Create/Edit the /etc/systemd/system/docker.service.d/docker.conf file.

    Override the ExecStart configuration from your docker.service file to customize the docker daemon. To modify the ExecStart configuration you have to specify an empty configuration followed by a new one as follows:

    $ sudo vi /etc/systemd/system/docker.service.d/docker.conf
    [Service]
    ExecStart=
    ExecStart=/usr/bin/dockerd --insecure-registry 172.30.0.0/16
  3. Restart the docker daemon.

    $ sudo systemctl daemon-reload; sudo systemctl restart docker
  4. Restart the OpenShift cluster

$ oc cluster up --public-hostname=ec2-1-2-3-4.eu-west-1.compute.amazonaws.com --routing-suffix=1.2.3.4.xip.io

9.2.4. Access the Console

We can now access the OpenShift console on: https://1.2.3.4:8443/console

The process of creating a project and application follows that of OpenShift Local.

9.3. Source to Image

The WildFly-Camel Docker image is capabale of performing Source-To-Image builds.

This enables you to build reproducable images from source.

9.3.1. Example S2I build

First you’ll need to download and install the S2I tooling from here.

Then you can build and run a Docker image from source. For example, to build the WildFly-Camel CDI quickstart:

$ s2i build https://github.com/wildfly-extras/wildfly-camel-examples.git -r 4.7.0 --context-dir camel-cdi wildflyext/wildfly-camel:4.7.0 wildfly-camel-example-cdi
$ docker run -ti -p 8080:8080 wildfly-camel-example-cdi

From a remote client, you should now be able to access the service like this

Hello Kermit

9.3.2. S2I with OpenShift Origin

WildFly-Camel provides an OpenShift builder image, which enables you to do a source to image in OpenShift.

First add the WildFly-Camel S2I ImageStream.

$ oc apply -f http://wildfly-extras.github.io/wildfly-camel/sources/wildfly-camel-imagestream.json

When you select 'Add to Project' in the OpenShift web console you should see a new catalog item named 'wildfly-camel'. Choose this option, then provide the required parameters.

wildfly camel s2i builder01

To build the latest release of the WildFly-Camel CDI example you would enter:

Name

camel-cdi

Git Repository URL

https://github.com/wildfly-extras/wildfly-camel-examples

Git Reference

4.7.0

Context Dir

camel-cdi

Click 'Create' to start the build process.

You’ll then be able to monitor your application S2I build and deployment in OpenShift. Eventually you should see your application with 1 pod running.

wildfly camel s2i builder02

Then to access the application you can browse to the route endpoint URL. For example:

Hello Kermit

10. Security

Security in WildFly is a broad topic. Both WildFly and Camel have well documented, stadardised methods of securing configuration, endpoints and payloads.

10.1. JAX-RS Security

The following topics explain how to secure JAX-RS endpoints.

10.2. JAX-WS Security

The following topics explain how to secure JAX-WS endpoints.

10.3. JMS Security

The following topics explain how to secure JMS endpoints.

In addition to that, we use Camel’s notion of Route Policies to integrate with the WildFly security system.

10.4. Route Policy

Camel supports the notion of RoutePolicies, which can be used to integrate with the WildFly security system. There are currently two supported scenarios for security integration.

10.4.1. Camel calls into JavaEE

When a camel route calls into a secured JavaEE component, it acts as a client and must provide appropriate credentials associated with the call.

The route can be decorated with a ClientAuthorizationPolicy

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .policy(new ClientAuthorizationPolicy())
        .to("ejb:java:module/AnnotatedSLSB?method=doSelected");
    }
});

This does actually no do any authentication/authorization as part of the Camel message processing. Instead it associates the credentials that come with the Camel Exchange with the call into the EJB3 layer.

The client that calls the message consumer must provide appropriate credentials in the AUTHENTICATION header like this:

ProducerTemplate producer = camelctx.createProducerTemplate();
Subject subject = new Subject();
subject.getPrincipals().add(new DomainPrincipal(domain));
subject.getPrincipals().add(new EncodedUsernamePasswordPrincipal(username, password));
producer.requestBodyAndHeader("direct:start", "Kermit", Exchange.AUTHENTICATION, subject, String.class);

Authentication and authorization will happen in the JavaEE layer.

10.4.2. Securing a Camel Route

In order to secure a Camel Route, we can associate a DomainAuthorizationPolicy with the route. This policy requires a successful authentication against the given security domain and authorization for "Role2".

CamelContext camelctx = new DefaultCamelContext();
camelctx.addRoutes(new RouteBuilder() {
    @Override
    public void configure() throws Exception {
        from("direct:start")
        .policy(new DomainAuthorizationPolicy().roles("Role2"))
        .transform(body().prepend("Hello "));
    }
});
camelctx.start();

Again, the client that calls the message consumer must provide appropriate credentials in the AUTHENTICATION header like this:

ProducerTemplate producer = camelctx.createProducerTemplate();
Subject subject = new Subject();
subject.getPrincipals().add(new DomainPrincipal(domain));
subject.getPrincipals().add(new EncodedUsernamePasswordPrincipal(username, password));
producer.requestBodyAndHeader("direct:start", "Kermit", Exchange.AUTHENTICATION, subject, String.class);

11. Developer Info