EIPs

Camel supports most of the Enterprise Integration Patterns from the excellent book by Gregor Hohpe and Bobby Woolf.

If you come from an AI, data engineering, or modern distributed systems background, see AI Patterns for a mapping of common terms like fan-out, scatter-gather, and retry to the corresponding Camel EIPs.

Messaging Systems

image

Message Channel

How does one application communicate with another using messaging?

image

Message

How can two applications be connected by a message channel exchange a piece of information?

image

Pipes and Filters

How can we perform complex processing on a message while maintaining independence and flexibility?

image

Message Router

How can you decouple individual processing steps so that messages can be passed to different filters depending on a set of conditions?

image

Message Translator

How can systems using different data formats communicate with each other using messaging?

image

Message Endpoint

How does an application connect to a messaging channel to send and receive messages?

Messaging Channels

image

Point to Point Channel

How can the caller be sure that exactly one receiver will receive the document or perform the call?

image

Publish Subscribe Channel

How can the sender broadcast an event to all interested receivers?

image

Dead Letter Channel

What will the messaging system do with a message it cannot deliver?

image

Guaranteed Delivery

How can the sender make sure that a message will be delivered, even if the messaging system fails?

image

Channel Adapter

How can you connect an application to the messaging system so that it can send and receive messages?

image

Messaging Bridge

How can multiple messaging systems be connected so that messages available on one are also available on the others?

image

Message Bus

What is an architecture that enables separate applications to work together, but in a de-coupled fashion such that applications can be easily added or removed without affecting the others?

image

Change Data Capture

Data synchronization by capturing changes made to a database, and apply those changes to another system.

Message Construction

image

Event Message

How can messaging be used to transmit events from one application to another?

image

Request Reply

When an application sends a message, how can it get a response from the receiver?

image

Return Address

How does a replier know where to send the reply?

image

Correlation Identifier

How does a requestor that has received a reply know which request this is the reply for?

image

Message Expiration

How can a sender indicate when a message should be considered stale and thus shouldn’t be processed?

Message Routing

image

Content-Based Router

How do we handle a situation where the implementation of a single logical function (e.g., inventory check) is spread across multiple physical systems?

image

Message Filter

How can a component avoid receiving uninteresting messages?

image

Dynamic Router

How can you avoid the dependency of the router on all possible destinations while maintaining its efficiency?

image

Recipient List

How do we route a message to a list of (static or dynamically) specified recipients?

image

Routing Slip

How do we route a message consecutively through a series of processing steps when the sequence of steps is not known at design-time and may vary for each message?

image

Process Manager

How do we route a message through multiple processing steps when the required steps may not be known at design-time and may not be sequential?

image

Message Broker

How can you decouple the destination of a message from the sender and maintain central control over the flow of messages?

image

Multicast

How can I route a message to a number of endpoints at the same time?

image

Load Balancer

How can I balance load across a number of endpoints?

image

Kamelet

How can I call Kamelets (route templates)?

image

Sampling

How can I sample one message out of many in a given period to avoid downstream route does not get overloaded?

Load Balancing Strategies

image

Failover Load Balancer

Tries the next endpoint in case of failure.

image

Round Robin Load Balancer

Distributes messages across endpoints in a round robin fashion.

image

Random Load Balancer

Distributes messages across endpoints randomly.

image

Weighted Load Balancer

Distributes messages across endpoints using weighted ratios.

image

Sticky Load Balancer

Routes messages to the same endpoint based on a correlation expression.

image

Topic Load Balancer

Sends the message to all endpoints (like a topic).

image

Custom Load Balancer

Uses a custom load balancing implementation.

Splitting and Aggregation

image

Splitter

How can we process a message if it contains multiple elements, each of which may have to be processed in a different way?

image

Aggregator

How do we combine the results of individual, but related, messages so that they can be processed as a whole?

image

Resequencer

How can we get a stream of related but out-of-sequence messages back into the correct order?

image

Composed Message Processor

How can you maintain the overall message flow when processing a message consisting of multiple elements, each of which may require different processing?

image

Scatter-Gather

How do you maintain the overall message flow when a message needs to be sent to multiple recipients, each of which may send a reply?

Message Transformation

image

Content Enricher

How do we communicate with another system if the message originator does not have all the required data items available?

image

Enrich

Enriches the message with data from a secondary resource using a request-reply pattern.

image

Poll Enrich

Enriches the message with data obtained by polling a consumer endpoint.

image

Poll

Polls a message from an endpoint for later use in the routing.

image

Content Filter

How do you simplify dealing with a large message when you are interested only in a few data items?

image

Claim Check

How can we reduce the data volume of a message sent across the system without sacrificing information content?

image

Normalizer

How do you process messages that are semantically equivalent, but arrive in a different format?

image

Sort

How can I sort the body of a message?

image

Script

How do I execute a script which may not change the message?

image

Validate

How can I validate a message?

Message Data Manipulation

image

Set Body

Sets the message body to the result of an expression.

image

Set Header

Sets a single message header to the result of an expression.

image

Set Headers

Sets multiple message headers at the same time.

image

Set Property

Sets an exchange property to the result of an expression.

image

Set Variable

Sets a variable to the result of an expression.

image

Set Variables

Sets multiple variables at the same time.

image

Remove Header

Removes a single message header by name.

image

Remove Headers

Removes message headers matching a pattern.

image

Remove Property

Removes a single exchange property by name.

image

Remove Properties

Removes exchange properties matching a pattern.

image

Remove Variable

Removes a variable by name.

image

Convert Body To

Converts the message body to another type.

image

Convert Header To

Converts a message header to another type.

image

Convert Variable To

Converts a variable to another type.

image

Transform

Transforms the message body based on an expression and stops further routing.

image

Transform Data Type

Transforms the message between named data types.

image

Marshal

Marshals the message body into a binary or textual format using a data format.

image

Unmarshal

Unmarshals the message body from a binary or textual format using a data format.

Endpoints and Invocation

image

From

Defines the consumer endpoint that acts as the input source for a route.

image

To

Sends the message to a fixed endpoint URI.

image

To D

Sends the message to an endpoint URI computed dynamically from an expression.

image

Bean

Invokes a method on a Java bean with automatic parameter binding.

image

Process

Invokes a custom Camel Processor for programmatic message processing.

Messaging Endpoints

image

Messaging Mapper

How do you move data between domain objects and the messaging infrastructure while keeping the two independent of each other?

image

Event Driven Consumer

How can an application automatically consume messages as they become available?

image

Polling Consumer

How can an application consume a message when the application is ready?

image

Competing Consumers

How can a messaging client process multiple messages concurrently?

image

Message Dispatcher

How can multiple consumers on a single channel coordinate their message processing?

image

Selective Consumer

How can a message consumer select which messages it wishes to receive?

image

Durable Subscriber

How can a subscriber avoid missing messages while it’s not listening for them?

image

Idempotent Consumer

How can a message receiver deal with duplicate messages?

image

Resumable Consumer

How can a message receiver resume from the last known offset?

image

Transactional Client

How can a client control its transactions with the messaging system?

image

Messaging Gateway

How do you encapsulate access to the messaging system from the rest of the application?

image

Service Activator

How can an application design a service to be invoked both via various messaging technologies and via non-messaging techniques?

Flow Control

image

Throttler

How can I throttle messages to ensure that a specific endpoint does not get overloaded, or we don’t exceed an agreed SLA with some external service?

image

Delayer

How can I delay the sending of a message?

image

Loop

How can I repeat processing a message in a loop?

image

Stop

How can I stop to continue routing a message?

image

Threads

How can I decouple the continued routing of a message from the current thread?

Error Handling and Resilience

image

Circuit Breaker

How can I stop calling an external service if the service is broken?

image

On Fallback

Defines the fallback route that executes when the Circuit Breaker trips or the primary route fails.

image

Saga

How can I define a series of related actions in a Camel route that should be either completed successfully (all of them) or not-executed/compensated?

image

Throw Exception

How can I throw an exception during routing?

image

Rollback

Marks the current exchange for rollback, typically used with transactions.

System Management

image

ControlBus

How can we effectively administer a messaging system distributed across multiple platforms and a wide geographic area?

image

Detour

How can you route a message through intermediate steps to perform validation, testing or debugging functions?

image

Wire Tap

How do you inspect messages that travel on a point-to-point channel?

image

Message History

How can we effectively analyze and debug the flow of messages in a loosely coupled system?

image

Log

How can I log processing a message?

image

Step

Groups together a set of EIPs into a composite logical unit for metrics and monitoring.