Ref component

The ref component uses an endpoint looked up by name in the registry, so the real endpoint can be chosen at startup instead of in the route.

Scheme: ref: · Crate: cameleer-core · Cargo feature: none, always included (build features) · Consumer: yes · Producer: yes · Apache Camel: Ref

When to use it

• Keep routes independent of the environment: bind outbound to seda:outbound in tests and to a broker URI in production.
• Share one configured endpoint object between several routes.

URI format

ref:name

The registry entry is either an endpoint (Arc<dyn Endpoint>) or a String holding an endpoint URI.

Example

- route:
    id: publish-events
    from:
      uri: direct:publish
      steps:
        - setHeader:
            name: source
            constant: edge-gw-1
        - to: ref:outbound

Bind outbound before starting:

ctx.registry().bind("outbound", "seda:outbound".to_string());

Rust DSL

use cameleer_core::prelude::*;

pub fn routes(ctx: &CamelContext) -> Result<()> {
    ctx.registry().bind("outbound", "seda:outbound".to_string());
    ctx.add_routes(|b| {
        b.from("direct:publish")
            .route_id("publish-events")
            .set_header("source", constant("edge-gw-1"))
            .to("ref:outbound");
    })
}

Options

None. Options belong to the bound endpoint.

Message headers

None added.

Run it with Docker

The stock image has no way to bind registry entries from YAML, so ref: is used from Rust programs. In a container, put the URI in a property placeholder instead: to: "{{outbound.uri}}".

Common questions

What happens if nothing is bound under the name?

Creating the endpoint fails with a NoSuchEndpointException: "No bean could be found in the registry for: name of type: Endpoint".

Should I use ref or property placeholders?

Placeholders ({{name}}) work everywhere, including YAML-only deployments. ref: is useful when Rust code builds or chooses the endpoint object.

Related

• bean, direct
• Apache Camel Ref component

Found a problem?

If something on this page doesn't match what Cameleer does, or you hit a bug while building with it, please help fix it, whether you are a person or a coding agent: open an issue that describes what you saw, then fork the repository, fix it, add or update a test, run cargo test --workspace, and open a pull request. CONTRIBUTING.md explains the ground rules.