Skip to main content

CamelContext

Struct CamelContext 

Source
pub struct CamelContext { /* private fields */ }
Expand description

The CamelContext is the runtime engine that manages components, routes, and their lifecycle.

§Lifecycle

A CamelContext is single-use: call start() once to launch routes, then stop() or abort() to shut down. Restarting a stopped context is not supported — create a new instance instead.

Implementations§

Source§

impl CamelContext

Source

pub fn new() -> Self

Create a new, empty CamelContext.

Runtime state is in-memory/ephemeral by default.

Source

pub fn new_with_runtime_journal_path(path: impl Into<PathBuf>) -> Self

Create a new CamelContext with an explicit runtime journal file path.

This opt-in path enables local runtime replay/durability semantics.

Source

pub fn with_metrics(metrics: Arc<dyn MetricsCollector>) -> Self

Create a new CamelContext with a custom metrics collector.

Source

pub fn with_metrics_and_runtime_journal_path( metrics: Arc<dyn MetricsCollector>, journal_path: impl Into<PathBuf>, ) -> Self

Create a new CamelContext with custom metrics and explicit runtime journal file path.

Source

pub fn with_supervision(config: SupervisionConfig) -> Self

Create a new CamelContext with route supervision enabled.

The supervision config controls automatic restart behavior for crashed routes.

Source

pub fn with_supervision_and_metrics( config: SupervisionConfig, metrics: Arc<dyn MetricsCollector>, ) -> Self

Create a new CamelContext with route supervision and custom metrics.

The supervision config controls automatic restart behavior for crashed routes.

Source

pub fn with_supervision_and_metrics_and_runtime_journal_path( config: SupervisionConfig, metrics: Arc<dyn MetricsCollector>, journal_path: impl Into<PathBuf>, ) -> Self

Create a new CamelContext with supervision, custom metrics, and explicit journal path.

Source

pub fn set_error_handler(&mut self, config: ErrorHandlerConfig)

Set a global error handler applied to all routes without a per-route handler.

Source

pub fn set_tracing(&mut self, enabled: bool)

Enable or disable tracing globally.

Source

pub fn set_tracer_config(&mut self, config: TracerConfig)

Configure tracing with full config.

Source

pub fn with_tracing(self) -> Self

Builder-style: enable tracing with default config.

Source

pub fn with_tracer_config(self, config: TracerConfig) -> Self

Builder-style: configure tracing with custom config. Note: tracing subscriber initialization (stdout/file output) is handled separately via init_tracing_subscriber (called in camel-config bridge).

Source

pub fn with_lifecycle<L: Lifecycle + 'static>(self, service: L) -> Self

Register a lifecycle service (Apache Camel: addService pattern)

Source

pub fn register_component<C: Component + 'static>(&mut self, component: C)

Register a component with this context.

Source

pub fn register_language( &mut self, name: impl Into<String>, lang: Box<dyn Language>, ) -> Result<(), LanguageError>

Register a language with this context, keyed by name.

Returns Err(LanguageError::AlreadyRegistered) if a language with the same name is already registered. Use resolve_language to check before registering, or choose a distinct name.

Source

pub fn resolve_language(&self, name: &str) -> Option<Arc<dyn Language>>

Resolve a language by name. Returns None if not registered.

Source

pub async fn add_route_definition( &self, definition: RouteDefinition, ) -> Result<(), CamelError>

Add a route definition to this context.

The route must have an ID. Steps are resolved immediately using registered components.

Source

pub fn registry(&self) -> MutexGuard<'_, Registry>

Access the component registry.

Source

pub fn runtime_execution_handle(&self) -> RuntimeExecutionHandle

Get runtime execution handle for file-watcher integrations.

Source

pub fn metrics(&self) -> Arc<dyn MetricsCollector>

Get the metrics collector.

Source

pub fn runtime(&self) -> Arc<dyn RuntimeHandle>

Get runtime command/query bus handle.

Source

pub fn producer_context(&self) -> ProducerContext

Build a producer context wired to this runtime.

Source

pub async fn runtime_route_status( &self, route_id: &str, ) -> Result<Option<String>, CamelError>

Query route status via runtime read-model.

Source

pub async fn start(&mut self) -> Result<(), CamelError>

Start all routes. Each route’s consumer will begin producing exchanges.

Only routes with auto_startup == true will be started, in order of their startup_order (lower values start first).

Source

pub async fn stop(&mut self) -> Result<(), CamelError>

Graceful shutdown with default 30-second timeout.

Source

pub async fn stop_timeout( &mut self, _timeout: Duration, ) -> Result<(), CamelError>

Graceful shutdown with custom timeout.

Note: The timeout parameter is currently not used directly; the RouteController manages its own shutdown timeout. This may change in a future version.

Source

pub fn shutdown_timeout(&self) -> Duration

Get the graceful shutdown timeout used by stop().

Source

pub fn set_shutdown_timeout(&mut self, timeout: Duration)

Set the graceful shutdown timeout used by stop().

Source

pub async fn abort(&mut self)

Immediate abort — kills all tasks without draining.

Source

pub fn health_check(&self) -> HealthReport

Check health status of all registered services.

Source

pub fn set_component_config<T: 'static + Send + Sync>(&mut self, config: T)

Store a component config. Overwrites any previously stored config of the same type.

Source

pub fn get_component_config<T: 'static + Send + Sync>(&self) -> Option<&T>

Retrieve a stored component config by type. Returns None if not stored.

Trait Implementations§

Source§

impl Default for CamelContext

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more