DOCSEARCHbyAlgolia
Submit Docs

Apache Camel

repository·main·Indexed 27 days ago

https://github.com/apache/camel

An open-source integration framework providing over 350 connectors to facilitate communication between diverse systems such as databases, APIs, message brokers, and cloud services. It enables developers to define integration logic (routes) using Java, YAML, or XML. The framework includes various components for services like AWS SQS, Azure Files, Braintree, Google BigQuery, Google Functions, Google PubSub, Docker, and CM SMS.

Tokens
220.1K
Snippets
675
Records
1.2K
Agent score
92%

What's inside Apache Camel

  1. Overview of Camel CLI capabilities

    main

    The Camel CLI supports a full development lifecycle including:

    • Running & Dev Mode: Hot reload, profiles, properties, and dependency management.
    • Dev Services: Managing local infrastructure (databases, brokers) via containers.
    • Data Transformation: Transforming messages using expression languages and data formats.
    • Debugging & Management: Route debugging, message tracing, health checks, metrics, and log tailing.
    • AI Integration: Using the Camel MCP Server to expose the Camel catalog to AI tools like Claude Code or GitHub Copilot.
    • Exporting: Converting prototypes into production-ready Spring Boot, Quarkus, or Camel Main Maven projects using camel export.

  2. Overview of Apache Camel Integration Framework

    main
    Apache Camel is an open-source integration framework based on Enterprise Integration Patterns (EIP). It allows you to define routing and mediation rules using various Domain-Specific Languages (DSLs), including Java, XML, Groovy, and YAML. This multi-language support enables IDE features like smart completion for routing rules.

  3. Mock OpenAI Chat Completions API with OpenAI Mock

    main

    OpenAI Mock is a lightweight Java library designed to mock OpenAI's chat completions API (/v1/chat/completions) during unit testing. It uses a local Java HttpServer to intercept requests and return predefined responses, allowing tests to run without actual network calls to OpenAI.

    To use it, you must configure your application's HTTP client to point to the URL provided by openAIMock.getBaseUrl() instead of the real OpenAI endpoint.

  4. Explore Apache Camel components, data formats, and languages

    main

    Apache Camel provides a wide array of artifacts to facilitate integration. You can find the most up-to-date lists of available extensions on the official Camel website:

    • Components: For connecting to various systems and protocols.
    • Data Formats: For marshalling and unmarshalling data (e.g., JSON, XML).
    • Languages: For expression languages used within routes.
    • Miscellaneous: Other specialized components and utilities.

  5. Choose an Apache Camel Runtime

    main

    Apache Camel can be deployed across various runtimes depending on your requirements:

    • Camel Spring Boot: Camel on Spring Boot with starters for 350+ connectors.
    • Camel Quarkus: Cloud-native Camel optimized for fast startup, low memory, and native compilation.
    • Camel CLI: Command-line tool to run, develop, test, and trace routes.
    • Camel K: For Kubernetes environments.
    • Camel Karaf: For OSGi environments.
    • Camel Kafka Connector: For use within Kafka Connect.

  6. Use the Mock Component for testing

    main

    The Mock component allows you to test routes and mediation rules by setting declarative expectations on mock endpoints before a test begins. You can verify the number of messages, payloads, order of arrival, and specific headers or predicates.

    Warning: Mock endpoints keep received Exchanges in memory indefinitely by default. For high-volume tests, use retainFirst and retainLast options to limit memory usage, or consider using NotifyBuilder or AdviceWith instead of adding mock endpoints directly to routes.

    mock:someName[?options]

  7. Understand Camel Health Check concepts

    main

    Camel uses a pluggable health check strategy based on several core components:

    • HealthCheck: Defines the basic contract for a single health check.
    • HealthCheckResponse: Represents the result of a health check invocation.
    • HealthCheckConfiguration: Holds settings like minimum delay between calls and failure thresholds.
    • HealthCheckRegistry: A registry for managing health checks (use the default implementation provided by Camel).
    • HealthCheckRepository: An interface for defining health check providers. Components can provide their own repositories, or you can add custom checks by instantiating beans in Spring/Spring Boot.

  8. Use the Schematron Component for XML validation

    main
    The Schematron component allows you to validate XML instance documents using the Schematron ISO standard. It is used to express operational and business rules, verify data interdependencies (co-constraints), check data cardinality, and perform algorithmic checks on XML data.

  9. Use PQC DataFormat for quantum-resistant encryption

    main

    The PQC (Post-Quantum Cryptography) DataFormat allows you to encrypt and decrypt message payloads using a combination of a Key Encapsulation Mechanism (KEM) and symmetric AEAD encryption. This provides defense-in-depth by protecting the shared secret with quantum-resistant algorithms (like ML-KEM) and the data with standard symmetric algorithms (like AES).

    Wire Format (Camel 4.22+): [4 bytes: encapsulation length] [N bytes: encapsulation] [12 bytes: AEAD nonce] [M bytes: ciphertext + auth tag]

    Note: Data encrypted with versions earlier than Camel 4.22 used unauthenticated ECB and is incompatible with 4.22+.

    // Create PQC DataFormat
PQCDataFormat pqcFormat = new PQCDataFormat();
pqcFormat.setKeyEncapsulationAlgorithm("MLKEM");
pqcFormat.setSymmetricKeyAlgorithm("AES");
pqcFormat.setSymmetricKeyLength(256);

from("direct:encrypt")
    .marshal(pqcFormat)
    .to("file:encrypted");

from("file:encrypted")
    .unmarshal(pqcFormat)
    .to("direct:decrypted");

  10. Use Camel XMPP for Jabber communication

    main
    The Camel XMPP component provides a transport for communicating with Jabber (XMPP) servers. It allows you to integrate XMPP messaging capabilities into your Apache Camel routes. For detailed documentation and configuration options, visit the official Camel XMPP page.

  12. Use the Keycloak Component for Producer, Consumer, or Security operations

    main

    The Keycloak component (camel-keycloak) provides three main functionalities:

    1. Producer Operations: Manage Keycloak instances via the Admin API (realms, users, roles, clients, groups, sessions, tokens, etc.).
    2. Consumer Operations: Poll and consume user events (logins, logouts, registrations) and admin events from Keycloak.
    3. Security Policies: Implement route-level authorization using Keycloak authentication and authorization services (role-based, permission-based, or OAuth 2.0 token introspection).

    URI Format: keycloak://label[?options]