camel-yaml-dsl.json

required: steps uri

title: Aggregate

description: Aggregates many messages into a single message

title: Aggregate Controller

description: To use a org.apache.camel.processor.aggregate.AggregateController to allow external sources to control this aggregator.

title: Aggregation Repository

description: The AggregationRepository to use. Sets the custom aggregate repository to use. Will by default use org.apache.camel.processor.aggregate.MemoryAggregationRepository

title: Aggregation Strategy

description: The AggregationStrategy to use. For example to lookup a bean with the name foo, the value is simply just #bean:foo. Configuring an AggregationStrategy is required, and is used to merge the incoming Exchange with the existing already merged exchanges. At first call the oldExchange parameter is null. On subsequent invocations the oldExchange contains the merged exchanges and newExchange is of course the new incoming Exchange.

title: Aggregation Strategy Method Allow Null

description: If this option is false then the aggregate method is not used for the very first aggregation. If this option is true then null values is used as the oldExchange (at the very first aggregation), when using beans as the AggregationStrategy.

title: Aggregation Strategy Method Name

description: This option can be used to explicit declare the method name to use, when using beans as the AggregationStrategy.

title: Close Correlation Key On Completion

description: Closes a correlation key when its complete. Any late received exchanges which has a correlation key that has been closed, it will be defined and a ClosedCorrelationKeyException is thrown.

title: Complete All On Stop

description: Indicates to wait to complete all current and partial (pending) aggregated exchanges when the context is stopped. This also means that we will wait for all pending exchanges which are stored in the aggregation repository to complete so the repository is empty before we can stop. You may want to enable this when using the memory based aggregation repository that is memory based only, and do not store data on disk. When this option is enabled, then the aggregator is waiting to complete all those exchanges before its stopped, when stopping CamelContext or the route using it.

title: Completion From Batch Consumer

description: Enables the batch completion mode where we aggregate from a org.apache.camel.BatchConsumer and aggregate the total number of exchanges the org.apache.camel.BatchConsumer has reported as total by checking the exchange property org.apache.camel.Exchange#BATCH_COMPLETE when its complete. This option cannot be used together with discardOnAggregationFailure.

title: Completion Interval

description: A repeating period in millis by which the aggregator will complete all current aggregated exchanges. Camel has a background task which is triggered every period. You cannot use this option together with completionTimeout, only one of them can be used.

title: Completion On New Correlation Group

description: Enables completion on all previous groups when a new incoming correlation group. This can for example be used to complete groups with same correlation keys when they are in consecutive order. Notice when this is enabled then only 1 correlation group can be in progress as when a new correlation group starts, then the previous groups is forced completed.

title: Completion Predicate

description: A Predicate to indicate when an aggregated exchange is complete. If this is not specified and the AggregationStrategy object implements Predicate, the aggregationStrategy object will be used as the completionPredicate.

title: Completion Size

description: Number of messages aggregated before the aggregation is complete. This option can be set as either a fixed value or using an Expression which allows you to evaluate a size dynamically - will use Integer as result. If both are set Camel will fallback to use the fixed value if the Expression result was null or 0.

title: Completion Size Expression

title: Completion Timeout

description: Time in millis that an aggregated exchange should be inactive before its complete (timeout). This option can be set as either a fixed value or using an Expression which allows you to evaluate a timeout dynamically - will use Long as result. If both are set Camel will fallback to use the fixed value if the Expression result was null or 0. You cannot use this option together with completionInterval, only one of the two can be used. By default the timeout checker runs every second, you can use the completionTimeoutCheckerInterval option to configure how frequently to run the checker. The timeout is an approximation and there is no guarantee that the a timeout is triggered exactly after the timeout value. It is not recommended to use very low timeout values or checker intervals.

title: Completion Timeout Checker Interval

description: Interval in millis that is used by the background task that checks for timeouts ( org.apache.camel.TimeoutMap ). By default the timeout checker runs every second. The timeout is an approximation and there is no guarantee that the a timeout is triggered exactly after the timeout value. It is not recommended to use very low timeout values or checker intervals.

title: Completion Timeout Expression

title: Correlation Expression

description: The expression used to calculate the correlation key to use for aggregation. The Exchange which has the same correlation key is aggregated together. If the correlation key could not be evaluated an Exception is thrown. You can disable this by using the ignoreBadCorrelationKeys option.

title: Id

description: Sets the id of this node

title: Disabled

description: Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.

title: Discard On Aggregation Failure

description: Discards the aggregated message when aggregation failed (an exception was thrown from AggregationStrategy . This means the partly aggregated message is dropped and not sent out of the aggregator. This option cannot be used together with completionFromBatchConsumer.

title: Discard On Completion Timeout

description: Discards the aggregated message on completion timeout. This means on timeout the aggregated message is dropped and not sent out of the aggregator.

title: Eager Check Completion

description: Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange.

title: Executor Service

description: If using parallelProcessing you can specify a custom thread pool to be used. In fact also if you are not using parallelProcessing this custom thread pool is used to send out aggregated exchanges as well.

title: Force Completion On Stop

description: Indicates to complete all current aggregated exchanges when the context is stopped

title: Id

description: Sets the id of this node

title: Ignore Invalid Correlation Keys

description: If a correlation key cannot be successfully evaluated it will be ignored by logging a DEBUG and then just ignore the incoming Exchange.

title: Optimistic Lock Retry Policy

description: Allows to configure retry settings when using optimistic locking.

title: Optimistic Locking

description: Turns on using optimistic locking, which requires the aggregationRepository being used, is supporting this by implementing org.apache.camel.spi.OptimisticLockingAggregationRepository .

title: Parallel Processing

description: When aggregated are completed they are being send out of the aggregator. This option indicates whether or not Camel should use a thread pool with multiple threads for concurrency. If no custom thread pool has been specified then Camel creates a default pool with 10 concurrent threads.

title: Timeout Checker Executor Service

description: If using either of the completionTimeout, completionTimeoutExpression, or completionInterval options a background thread is created to check for the completion for every aggregator. Set this option to provide a custom thread pool to be used rather than creating a new thread for every aggregator.

title: Bean

description: Calls a Java bean

title: Bean Type

description: Sets the class name (fully qualified) of the bean to use

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Method

description: Sets the method name on the bean to use

title: Ref

description: Sets a reference to an exiting bean to use, which is looked up from the registry

title: Scope

description: Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. So when using prototype scope then this depends on the bean registry implementation.

default: Singleton

enum: Singleton Request Prototype

title: Do Catch

description: Catches exceptions as part of a try, catch, finally block

title: Id

description: Sets the id of this node

title: Disabled

title: Exception

description: The exception(s) to catch.

title: Id

description: Sets the id of this node

title: On When

description: Sets an additional predicate that should be true before the onCatch is triggered. To be used for fine grained controlling whether a thrown exception should be intercepted by this exception type or not.

title: Choice

description: Route messages based on a series of predicates

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Otherwise

description: Sets the otherwise node

title: Precondition

description: Indicates whether this Choice EIP is in precondition mode or not. If so its branches (when/otherwise) are evaluated during startup to keep at runtime only the branch that matched.

title: When

description: Sets the when nodes

title: Circuit Breaker

description: Route messages in a fault tolerance way using Circuit Breaker

title: Configuration

description: Refers to a circuit breaker configuration (such as resillience4j, or microprofile-fault-tolerance) to use for configuring the circuit breaker EIP.

title: Id

description: Sets the id of this node

title: Disabled

title: Fault Tolerance Configuration

description: Configures the circuit breaker to use MicroProfile Fault Tolerance with the given configuration.

title: Id

description: Sets the id of this node

title: On Fallback

description: The fallback route path to execute that does not go over the network. This should be a static or cached result that can immediately be returned upon failure. If the fallback requires network connection then use onFallbackViaNetwork() .

title: Resilience4j Configuration

description: Configures the circuit breaker to use Resilience4j with the given configuration.

title: Claim Check

description: The Claim Check EIP allows you to replace message content with a claim check (a unique key), which can be used to retrieve the message content at a later time.

title: Aggregation Strategy

description: To use a custom AggregationStrategy instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time.

title: Aggregation Strategy Method Name

description: This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.

title: Id

description: Sets the id of this node

title: Disabled

title: Filter

description: Specify a filter to control what data gets merged data back from the claim check repository. The following syntax is supported: body - to aggregate the message body attachments - to aggregate all the message attachments headers - to aggregate all the message headers header:pattern - to aggregate all the message headers that matches the pattern. The following pattern rules are applied in this order: exact match, returns true wildcard match (pattern ends with a and the name starts with the pattern), returns true regular expression match, returns true otherwise returns false You can specify multiple rules separated by comma. For example, the following includes the message body and all headers starting with foo: body,header:foo. The syntax supports the following prefixes which can be used to specify include,exclude, or remove - to include (which is the default mode) - - to exclude (exclude takes precedence over include) -- - to remove (remove takes precedence) For example to exclude a header name foo, and remove all headers starting with bar, -header:foo,--headers:bar Note you cannot have both include and exclude header:pattern at the same time.

title: Id

description: Sets the id of this node

title: Key

description: To use a specific key for claim check id (for dynamic keys use simple language syntax as the key).

title: Operation

description: The claim check operation to use. The following operations are supported: Get - Gets (does not remove) the claim check by the given key. GetAndRemove - Gets and removes the claim check by the given key. Set - Sets a new (will override if key already exists) claim check with the given key. Push - Sets a new claim check on the stack (does not use key). Pop - Gets the latest claim check from the stack (does not use key).

enum: Get GetAndRemove Set Push Pop

title: Context Scan

description: Scans for Java org.apache.camel.builder.RouteBuilder instances in the context org.apache.camel.spi.Registry .

title: Excludes

description: Exclude finding route builder from these java package names.

title: Include Non Singletons

description: Whether to include non-singleton beans (prototypes) By default only singleton beans is included in the context scan

title: Includes

description: Include finding route builder from these java package names.

title: Convert Body To

description: Converts the message body to another type

title: Charset

description: To use a specific charset when converting

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Mandatory

description: When mandatory then the conversion must return a value (cannot be null), if this is not possible then NoTypeConversionAvailableException is thrown. Setting this to false could mean conversion is not possible and the value is null.

title: Type

description: The java type to convert to

title: Delay

description: Delays processing for a specified length of time

title: Async Delayed

description: Enables asynchronous delay which means the thread will not block while delaying.

title: Caller Runs When Rejected

description: Whether or not the caller should run the task when it was rejected by the thread pool. Is by default true

title: Id

description: Sets the id of this node

title: Disabled

title: Executor Service

description: To use a custom Thread Pool if asyncDelay has been enabled.

title: Expression

description: Expression to define how long time to wait (in millis)

title: Id

description: Sets the id of this node

title: Dynamic Router

description: Route messages based on dynamic rules

title: Cache Size

description: Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this dynamic router, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to call that returns the endpoint(s) to route to in the dynamic routing. Important: The expression will be called in a while loop fashion, until the expression returns null which means the dynamic router is finished.

title: Id

description: Sets the id of this node

title: Ignore Invalid Endpoints

description: Ignore the invalidate endpoint exception when try to create a producer with that endpoint

title: Uri Delimiter

description: Sets the uri delimiter to use

title: Enrich

description: Enriches a message with data from a secondary resource

title: Aggregate On Exception

description: If this option is false then the aggregate method is not used if there was an exception thrown while trying to retrieve the data to enrich from the resource. Setting this option to true allows end users to control what to do if there was an exception in the aggregate method. For example to suppress the exception or set a custom message body etc.

title: Aggregation Strategy

description: Sets the AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message. By default Camel will use the reply from the external service as outgoing message.

title: Aggregation Strategy Method Allow Null

description: If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy.

title: Aggregation Strategy Method Name

title: Allow Optimised Components

description: Whether to allow components to optimise enricher if they are org.apache.camel.spi.SendDynamicAware .

title: Cache Size

description: Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producer when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression that computes the endpoint uri to use as the resource endpoint to enrich from

title: Id

description: Sets the id of this node

title: Ignore Invalid Endpoint

title: Share Unit Of Work

description: Shares the org.apache.camel.spi.UnitOfWork with the parent and the resource exchange. Enrich will by default not share unit of work between the parent exchange and the resource exchange. This means the resource exchange has its own individual unit of work.

title: Error Handler

description: Camel error handling.

title: Id

description: The id of this node

title: Fault Tolerance Configuration

description: MicroProfile Fault Tolerance Circuit Breaker EIP configuration

title: Bulkhead Enabled

description: Whether bulkhead is enabled or not on the circuit breaker. Default is false.

title: Bulkhead Executor Service

description: References to a custom thread pool to use when bulkhead is enabled.

title: Bulkhead Max Concurrent Calls

description: Configures the max amount of concurrent calls the bulkhead will support.

title: Bulkhead Waiting Task Queue

description: Configures the task queue size for holding waiting tasks to be processed by the bulkhead.

title: Circuit Breaker

description: Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use.

title: Delay

description: Control how long the circuit breaker stays open. The default is 5 seconds.

title: Failure Ratio

description: Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage.

title: Id

description: The id of this node

title: Request Volume Threshold

description: Controls the size of the rolling window used when the circuit breaker is closed

title: Success Threshold

description: Controls the number of trial calls which are allowed when the circuit breaker is half-open

title: Timeout Duration

description: Configures the thread execution timeout. Default value is 1 second.

title: Timeout Enabled

description: Whether timeout is enabled or not on the circuit breaker. Default is false.

title: Timeout Pool Size

description: Configures the pool size of the thread pool when timeout is enabled. Default value is 10.

title: Timeout Scheduled Executor Service

description: References to a custom thread pool to use when timeout is enabled

title: Filter

description: Filter out messages based using a predicate

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to determine if the message should be filtered or not. If the expression returns an empty value or false then the message is filtered (dropped), otherwise the message is continued being routed.

title: Id

description: Sets the id of this node

title: Status Property Name

description: Name of exchange property to use for storing the status of the filtering. Setting this allows to know if the filter predicate evaluated as true or false.

title: Do Finally

description: Path traversed when a try, catch, finally block exits

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Global Option

description: Models a string key/value pair for configuring some global options on a Camel context such as max debug log length.

title: Key

description: Global option key

title: Value

description: Global option value

title: Global Options

description: Models a series of string key/value pairs for configuring some global options on a Camel context such as max debug log length.

title: Global Option

description: A series of global options as key value pairs

title: Idempotent Consumer

description: Filters out duplicate messages

title: Completion Eager

description: Sets whether to complete the idempotent consumer eager or when the exchange is done. If this option is true to complete eager, then the idempotent consumer will trigger its completion when the exchange reached the end of the block of the idempotent consumer pattern. So if the exchange is continued routed after the block ends, then whatever happens there does not affect the state. If this option is false (default) to not complete eager, then the idempotent consumer will complete when the exchange is done being routed. So if the exchange is continued routed after the block ends, then whatever happens there also affect the state. For example if the exchange failed due to an exception, then the state of the idempotent consumer will be a rollback.

title: Id

description: Sets the id of this node

title: Disabled

title: Eager

description: Sets whether to eagerly add the key to the idempotent repository or wait until the exchange is complete. Eager is default enabled.

title: Expression

description: Expression used to calculate the correlation key to use for duplicate check. The Exchange which has the same correlation key is regarded as a duplicate and will be rejected.

title: Id

description: Sets the id of this node

title: Idempotent Repository

description: Sets the reference name of the message id repository

title: Remove On Failure

description: Sets whether to remove or keep the key on failure. The default behavior is to remove the key on failure.

title: Skip Duplicate

description: Sets whether to skip duplicates or not. The default behavior is to skip duplicates. A duplicate message would have the Exchange property org.apache.camel.Exchange#DUPLICATE_MESSAGE set to a Boolean#TRUE value. A none duplicate message will not have this property set.

title: Input Type

description: Set the expected data type of the input message. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists. If validate attribute is true then camel applies Validator as well. Type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example {code java:java.lang.String} , {code json:ABCOrder} . It's also possible to specify only scheme part, so that it works like a wildcard. If only 'xml' is specified, all the XML message matches. It's handy to add only one transformer/validator for all the transformation from/to XML.

title: Id

description: Sets the id of this node

title: Id

description: Sets the id of this node

title: Urn

description: The input type URN.

title: Validate

description: Whether if validation is required for this input type.

title: Intercept

description: Intercepts a message at each step in the route

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Intercept From

description: Intercepts incoming messages

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Uri

description: Intercept incoming messages from the uri or uri pattern. If this option is not configured, then all incoming messages is intercepted.

title: Intercept Send To Endpoint

description: Intercepts messages being sent to an endpoint

title: After Uri

description: After sending to the endpoint then send the message to this uri which allows to process its result.

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Skip Send To Original Endpoint

description: If set to true then the message is not sent to the original endpoint. By default (false) the message is both intercepted and then sent to the original endpoint.

title: Uri

description: Intercept sending to the uri or uri pattern.

title: Load Balance

description: Balances message processing among a number of nodes

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Inherit Error Handler

description: Sets whether or not to inherit the configured error handler. The default value is true. You can use this to disable using the inherited error handler for a given DSL such as a load balancer where you want to use a custom error handler strategy.

title: Log

description: Logs the defined message to the logger

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Log Name

description: Sets the name of the logger

title: Logger

description: To refer to a custom logger instance to lookup from the registry.

title: Logging Level

description: Sets the logging level. The default value is INFO

title: Marker

description: To use slf4j marker

title: Message

description: Sets the log message (uses simple language)

title: Loop

description: Processes a message multiple times

title: Break On Shutdown

description: If the breakOnShutdown attribute is true, then the loop will not iterate until it reaches the end when Camel is shut down.

title: Copy

description: If the copy attribute is true, a copy of the input Exchange is used for each iteration. That means each iteration will start from a copy of the same message. By default loop will loop the same exchange all over, so each iteration may have different message content.

title: Id

description: Sets the id of this node

title: Disabled

title: Do While

description: Enables the while loop that loops until the predicate evaluates to false or null.

title: Expression

description: Expression to define how many times we should loop. Notice the expression is only evaluated once, and should return a number as how many times to loop. A value of zero or negative means no looping. The loop is like a for-loop fashion, if you want a while loop, then the dynamic router may be a better choice.

title: Id

description: Sets the id of this node

title: Marshal

description: Marshals data into a specified format for transmission over a transport or component

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Multicast

description: Routes the same message to multiple paths either sequentially or in parallel.

title: Aggregation Strategy

description: Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy

title: Aggregation Strategy Method Allow Null

description: If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy

title: Aggregation Strategy Method Name

title: Id

description: Sets the id of this node

title: Disabled

title: Executor Service

description: Refers to a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well.

title: Id

description: Sets the id of this node

title: On Prepare

description: Uses the Processor when preparing the org.apache.camel.Exchange to be send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send.

title: Parallel Aggregate

description: If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default this is false meaning that Camel synchronizes the call to the aggregate method. Though in some use-cases this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe.

title: Parallel Processing

description: If enabled then sending messages to the multicasts occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the multicasts which happens concurrently. When parallel processing is enabled, then the Camel routing engin will continue processing using last used thread from the parallel thread pool. However, if you want to use the original thread that called the multicast, then make sure to enable the synchronous option as well.

title: Share Unit Of Work

description: Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Multicast will by default not share unit of work between the parent exchange and each multicasted exchange. This means each sub exchange has its own individual unit of work.

title: Stop On Exception

description: Will now stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the multicast will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine. The default behavior is to not stop but continue processing till the end

title: Streaming

description: If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as defined by the multicast.

title: Synchronous

description: Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the multicast is complete, even if parallel processing is enabled.

title: Timeout

description: Sets a total timeout specified in millis, when using parallel processing. If the Multicast hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Multicast breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.

title: On Completion

description: Route to be executed when normal route processing completes

title: Id

description: Sets the id of this node

title: Disabled

title: Executor Service

description: To use a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well.

title: Id

description: Sets the id of this node

title: Mode

description: Sets the on completion mode. The default value is AfterConsumer

title: On Complete Only

description: Will only synchronize when the org.apache.camel.Exchange completed successfully (no errors).

title: On Failure Only

description: Will only synchronize when the org.apache.camel.Exchange ended with failure (exception or FAULT message).

title: On When

description: Sets an additional predicate that should be true before the onCompletion is triggered. To be used for fine grained controlling whether a completion callback should be invoked or not

title: Parallel Processing

description: If enabled then the on completion process will run asynchronously by a separate thread from a thread pool. By default this is false, meaning the on completion process will run synchronously using the same caller thread as from the route.

title: Use Original Message

description: Will use the original input message body when an org.apache.camel.Exchange for this on completion. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off.

title: On Exception

description: Route to be executed when an exception is thrown

title: Continued

description: Sets whether the exchange should handle and continue routing from the point of failure. If this option is enabled then its considered handled as well.

title: Id

description: Sets the id of this node

title: Disabled

title: Exception

description: A set of exceptions to react upon.

title: Handled

description: Sets whether the exchange should be marked as handled or not.

title: Id

description: Sets the id of this node

title: On Exception Occurred Ref

description: Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened. Important: Any exception thrown from this processor will be ignored.

title: On Redelivery Ref

description: Sets a reference to a processor that should be processed before a redelivery attempt. Can be used to change the org.apache.camel.Exchange before its being redelivered.

title: On When

description: Sets an additional predicate that should be true before the onException is triggered. To be used for fine grained controlling whether a thrown exception should be intercepted by this exception type or not.

title: Redelivery Policy

description: Used for configuring redelivery options

title: Redelivery Policy Ref

description: Sets a reference to a redelivery policy to lookup in the org.apache.camel.spi.Registry to be used.

title: Retry While

description: Sets the retry while predicate. Will continue retrying until predicate returns false.

title: Use Original Body

description: Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off.

title: Use Original Message

description: Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the split message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off.

title: On Fallback

description: Route to be executed when Circuit Breaker EIP executes fallback

title: Id

description: Sets the id of this node

title: Disabled

title: Fallback Via Network

description: Whether the fallback goes over the network. If the fallback will go over the network it is another possible point of failure. It is important to execute the fallback command on a separate thread-pool, otherwise if the main command were to become latent and fill the thread-pool this would prevent the fallback from running if the two commands share the same pool.

title: Id

description: Sets the id of this node

title: Optimistic Lock Retry Policy

description: To configure optimistic locking

title: Exponential Back Off

description: Enable exponential backoff

title: Maximum Retries

description: Sets the maximum number of retries

title: Maximum Retry Delay

description: Sets the upper value of retry in millis between retries, when using exponential or random backoff

title: Random Back Off

description: Enables random backoff

title: Retry Delay

description: Sets the delay in millis between retries

title: Otherwise

description: Route to be executed when all other choices evaluate to false

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Output Type

description: Set the expected data type of the output message. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists. If validate attribute is true then camel applies Validator as well. Type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example {code java:java.lang.String} , {code json:ABCOrder} . It's also possible to specify only scheme part, so that it works like a wildcard. If only 'xml' is specified, all the XML message matches. It's handy to add only one transformer/validator for all the XML-Java transformation.

title: Id

description: Sets the id of this node

title: Id

description: Sets the id of this node

title: Urn

description: Set output type URN.

title: Validate

description: Whether if validation is required for this output type.

title: Package Scan

description: Scans for Java org.apache.camel.builder.RouteBuilder classes in java packages

title: Excludes

title: Includes

title: Package

description: Sets the java package names to use for scanning for route builder classes

title: Pausable

description: Pausable EIP to support resuming processing from last known offset.

title: Consumer Listener

description: Sets the consumer listener to use

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Until Check

description: References to a java.util.function.Predicate to use for until checks. The predicate is responsible for evaluating whether the processing can resume or not. Such predicate should return true if the consumption can resume, or false otherwise. The exact point of when the predicate is called is dependent on the component, and it may be called on either one of the available events. Implementations should not assume the predicate to be called at any specific point.

title: Pipeline

description: Routes the message to a sequence of processors.

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Policy

description: Defines a policy the route will use

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Ref

description: Sets a reference to use for lookup the policy in the registry.

title: Poll Enrich

description: Enriches messages with data polled from a secondary resource

title: Aggregate On Exception

title: Aggregation Strategy

title: Aggregation Strategy Method Allow Null

title: Aggregation Strategy Method Name

title: Cache Size

description: Sets the maximum size used by the org.apache.camel.spi.ConsumerCache which is used to cache and reuse consumers when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

title: Id

description: Sets the id of this node

title: Ignore Invalid Endpoint

title: Timeout

description: Timeout in millis when polling from the external service. The timeout has influence about the poll enrich behavior. It basically operations in three different modes: negative value - Waits until a message is available and then returns it. Warning that this method could block indefinitely if no messages are available. 0 - Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet. positive value - Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns null if timed out The default value is -1 and therefore the method could block indefinitely, and therefore its recommended to use a timeout value

title: Process

description: Calls a Camel processor

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Ref

description: Reference to the Processor to lookup in the registry to use. Can also be used for creating new beans by their class name by prefixing with #class, eg #class:com.foo.MyClassType. And it is also possible to refer to singleton beans by their type in the registry by prefixing with #type: syntax, eg #type:com.foo.MyClassType

title: Property

description: A key value pair where the value is a literal value

title: Key

description: Property key

title: Value

description: Property value

title: Property Expression

description: A key value pair where the value is an expression.

title: Expression

description: Property values as an expression

title: Key

description: Property key

title: Recipient List

description: Route messages to a number of dynamically specified recipients

title: Aggregation Strategy

description: Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy

title: Aggregation Strategy Method Allow Null

title: Aggregation Strategy Method Name

title: Cache Size

description: Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.

title: Delimiter

description: Delimiter used if the Expression returned multiple endpoints. Can be turned off using the value false. The default value is ,

title: Id

description: Sets the id of this node

title: Disabled

title: Executor Service

title: Expression

description: Expression that returns which endpoints (url) to send the message to (the recipients). If the expression return an empty value then the message is not sent to any recipients.

title: Id

description: Sets the id of this node

title: Ignore Invalid Endpoints

title: On Prepare

description: Uses the Processor when preparing the org.apache.camel.Exchange to be used send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send.

title: Parallel Aggregate

title: Parallel Processing

description: If enabled then sending messages to the recipients occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the recipients which happens concurrently. When parallel processing is enabled, then the Camel routing engin will continue processing using last used thread from the parallel thread pool. However, if you want to use the original thread that called the recipient list, then make sure to enable the synchronous option as well.

title: Share Unit Of Work

description: Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Recipient List will by default not share unit of work between the parent exchange and each recipient exchange. This means each sub exchange has its own individual unit of work.

title: Stop On Exception

description: Will now stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the recipient list will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine. The default behavior is to not stop but continue processing till the end

title: Streaming

description: If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as defined by the recipient list.

title: Synchronous

description: Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the recipient list is complete, even if parallel processing is enabled.

title: Timeout

description: Sets a total timeout specified in millis, when using parallel processing. If the Recipient List hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Recipient List breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.

title: Redelivery Policy

description: To configure re-delivery for error handling

title: Allow Redelivery While Stopping

description: Controls whether to allow redelivery while stopping/shutting down a route that uses error handling.

title: Async Delayed Redelivery

description: Allow asynchronous delayed redelivery. The route, in particular the consumer's component, must support the Asynchronous Routing Engine (e.g. seda).

title: Back Off Multiplier

description: Sets the back off multiplier

title: Collision Avoidance Factor

description: Sets the collision avoidance factor

title: Delay Pattern

description: Sets the delay pattern with delay intervals.

title: Disable Redelivery

description: Disables redelivery (same as setting maximum redeliveries to 0)

title: Exchange Formatter Ref

description: Sets the reference of the instance of org.apache.camel.spi.ExchangeFormatter to generate the log message from exchange.

title: Id

description: The id of this node

title: Log Continued

description: Sets whether continued exceptions should be logged or not. Can be used to include or reduce verbose.

title: Log Exhausted

description: Sets whether exhausted exceptions should be logged or not. Can be used to include or reduce verbose.

title: Log Exhausted Message Body

description: Sets whether exhausted message body should be logged including message history or not (supports property placeholders). Can be used to include or reduce verbose. Requires logExhaustedMessageHistory to be enabled.

title: Log Exhausted Message History

description: Sets whether exhausted exceptions should be logged including message history or not (supports property placeholders). Can be used to include or reduce verbose.

title: Log Handled

description: Sets whether handled exceptions should be logged or not. Can be used to include or reduce verbose.

title: Log New Exception

description: Sets whether new exceptions should be logged or not. Can be used to include or reduce verbose. A new exception is an exception that was thrown while handling a previous exception.

title: Log Retry Attempted

description: Sets whether retry attempts should be logged or not. Can be used to include or reduce verbose.

title: Log Retry Stack Trace

description: Sets whether stack traces should be logged when an retry attempt failed. Can be used to include or reduce verbose.

title: Log Stack Trace

description: Sets whether stack traces should be logged. Can be used to include or reduce verbose.

title: Maximum Redeliveries

description: Sets the maximum redeliveries x = redeliver at most x times 0 = no redeliveries -1 = redeliver forever

title: Maximum Redelivery Delay

description: Sets the maximum delay between redelivery

title: Redelivery Delay

description: Sets the initial redelivery delay

title: Retries Exhausted Log Level

description: Sets the logging level to use when retries have been exhausted

title: Retry Attempted Log Interval

description: Sets the interval to use for logging retry attempts

title: Retry Attempted Log Level

description: Sets the logging level to use for logging retry attempts

title: Use Collision Avoidance

description: Turn on collision avoidance.

title: Use Exponential Back Off

description: Turn on exponential backk off

title: Remove Header

description: Removes a named header from the message

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Name

description: Name of header to remove

title: Remove Headers

description: Removes message headers whose name matches a specified pattern

title: Id

description: Sets the id of this node

title: Disabled

title: Exclude Pattern

description: Name or patter of headers to not remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).

title: Id

description: Sets the id of this node

title: Pattern

description: Name or pattern of headers to remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).

title: Remove Properties

description: Removes message exchange properties whose name matches a specified pattern

title: Id

description: Sets the id of this node

title: Disabled

title: Exclude Pattern

description: Name or pattern of properties to not remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).

title: Id

description: Sets the id of this node

title: Pattern

description: Name or pattern of properties to remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).

title: Remove Property

description: Removes a named property from the message exchange

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Name

description: Name of property to remove.

title: Resequence

description: Resequences (re-order) messages based on an expression

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to use for re-ordering the messages, such as a header with a sequence number

title: Id

description: Sets the id of this node

title: Resilience4j Configuration

description: Resilience4j Circuit Breaker EIP configuration

title: Automatic Transition From Open To Half Open Enabled

description: Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.

title: Bulkhead Enabled

title: Bulkhead Max Concurrent Calls

title: Bulkhead Max Wait Duration

description: Configures a maximum amount of time which the calling thread will wait to enter the bulkhead. If bulkhead has space available, entry is guaranteed and immediate. If bulkhead is full, calling threads will contest for space, if it becomes available. maxWaitDuration can be set to 0. Note: for threads running on an event-loop or equivalent (rx computation pool, etc), setting maxWaitDuration to 0 is highly recommended. Blocking an event-loop thread will most likely have a negative effect on application throughput.

title: Circuit Breaker

description: Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use.

title: Config

description: Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry.

title: Failure Rate Threshold

title: Id

description: The id of this node

title: Minimum Number Of Calls

description: Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate. For example, if minimumNumberOfCalls is 10, then at least 10 calls must be recorded, before the failure rate can be calculated. If only 9 calls have been recorded the CircuitBreaker will not transition to open even if all 9 calls have failed. Default minimumNumberOfCalls is 100

title: Permitted Number Of Calls In Half Open State

description: Configures the number of permitted calls when the CircuitBreaker is half open. The size must be greater than 0. Default size is 10.

title: Sliding Window Size

description: Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. slidingWindowSize configures the size of the sliding window. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. The slidingWindowSize must be greater than 0. The minimumNumberOfCalls must be greater than 0. If the slidingWindowType is COUNT_BASED, the minimumNumberOfCalls cannot be greater than slidingWindowSize . If the slidingWindowType is TIME_BASED, you can pick whatever you want. Default slidingWindowSize is 100.

title: Sliding Window Type

description: Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. Default slidingWindowType is COUNT_BASED.

title: Slow Call Duration Threshold

description: Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage. Default value is 60 seconds.

title: Slow Call Rate Threshold

description: Configures a threshold in percentage. The CircuitBreaker considers a call as slow when the call duration is greater than slowCallDurationThreshold Duration. When the percentage of slow calls is equal or greater the threshold, the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 100 percentage which means that all recorded calls must be slower than slowCallDurationThreshold.

title: Throw Exception When Half Open Or Open State

description: Whether to throw io.github.resilience4j.circuitbreaker.CallNotPermittedException when the call is rejected due circuit breaker is half open or open.

title: Timeout Cancel Running Future

description: Configures whether cancel is called on the running future. Defaults to true.

title: Timeout Duration

title: Timeout Enabled

title: Timeout Executor Service

description: References to a custom thread pool to use when timeout is enabled (uses ForkJoinPool#commonPool() by default)

title: Wait Duration In Open State

description: Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open. Default value is 60 seconds.

title: Writable Stack Trace Enabled

description: Enables writable stack traces. When set to false, Exception.getStackTrace returns a zero length array. This may be used to reduce log spam when the circuit breaker is open as the cause of the exceptions is already known (the circuit breaker is short-circuiting calls).

title: Rest Context Ref

description: To refer to an XML file with rest services defined using the rest-dsl

title: Ref

description: Reference to the rest-dsl

title: Resumable

description: Resume EIP to support resuming processing from last known offset.

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Intermittent

description: Sets whether the offsets will be intermittently present or whether they must be present in every exchange

title: Logging Level

title: Resume Strategy

description: Sets the resume strategy to use

title: Rollback

description: Forces a rollback by stopping routing the message

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Mark Rollback Only

description: Mark the transaction for rollback only (cannot be overruled to commit)

title: Mark Rollback Only Last

description: Mark only last sub transaction for rollback only. When using sub transactions (if the transaction manager support this)

title: Message

description: Message to use in rollback exception

title: Route Builder

description: To refer to a Java org.apache.camel.builder.RouteBuilder instance to use.

title: Id

description: The id of this node

title: Ref

description: Reference to the route builder instance

title: Route Configuration Context Ref

description: To refer to an XML file with route configuration defined using the xml-dsl

title: Ref

description: Reference to the route templates in the xml dsl

title: Route Context Ref

description: To refer to an XML file with routes defined using the xml-dsl

title: Ref

description: Reference to the routes in the xml dsl

title: Template Parameter

description: A route template parameter

title: Default Value

description: Default value of the parameter. If a default value is provided then the parameter is implied not to be required.

title: Description

description: Description of the parameter

title: Name

description: The name of the parameter

title: Required

description: Whether the parameter is required or not. A parameter is required unless this option is set to false or a default value has been configured.

title: Routing Slip

description: Routes a message through a series of steps that are pre-determined (the slip)

title: Cache Size

description: Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this routing slip, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to define the routing slip, which defines which endpoints to route the message in a pipeline style. Notice the expression is evaluated once, if you want a more dynamic style, then the dynamic router eip is a better choice.

title: Id

description: Sets the id of this node

title: Ignore Invalid Endpoints

title: Uri Delimiter

description: Sets the uri delimiter to use

title: Saga

description: Enables Sagas on the route

title: Compensation

description: The compensation endpoint URI that must be called to compensate all changes done in the route. The route corresponding to the compensation URI must perform compensation and complete without error. If errors occur during compensation, the saga service may call again the compensation URI to retry.

title: Completion

description: The completion endpoint URI that will be called when the Saga is completed successfully. The route corresponding to the completion URI must perform completion tasks and terminate without error. If errors occur during completion, the saga service may call again the completion URI to retry.

title: Completion Mode

description: Determine how the saga should be considered complete. When set to AUTO, the saga is completed when the exchange that initiates the saga is processed successfully, or compensated when it completes exceptionally. When set to MANUAL, the user must complete or compensate the saga using the saga:complete or saga:compensate endpoints.

title: Id

description: Sets the id of this node

title: Disabled

description: Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.

title: Id

description: Sets the id of this node

title: Option

description: Allows to save properties of the current exchange in order to re-use them in a compensation/completion callback route. Options are usually helpful e.g. to store and retrieve identifiers of objects that should be deleted in compensating actions. Option values will be transformed into input headers of the compensation/completion exchange.

title: Propagation

description: Set the Saga propagation mode (REQUIRED, REQUIRES_NEW, MANDATORY, SUPPORTS, NOT_SUPPORTED, NEVER).

enum: REQUIRED REQUIRES_NEW MANDATORY SUPPORTS NOT_SUPPORTED NEVER

title: Saga Service

description: Refers to the id to lookup in the registry for the specific CamelSagaService to use.

title: Timeout

description: Set the maximum amount of time for the Saga. After the timeout is expired, the saga will be compensated automatically (unless a different decision has been taken in the meantime).

title: Sample

description: Extract a sample of the messages passing through a route

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Message Frequency

description: Sets the sample message count which only a single Exchange will pass through after this many received.

title: Sample Period

description: Sets the sample period during which only a single Exchange will pass through.

title: Script

description: Executes a script from a language which does not change the message body.

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to return the transformed message body (the new message body to use)

title: Id

description: Sets the id of this node

title: Set Body

description: Sets the contents of the message body

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression that returns the new body to use

title: Id

description: Sets the id of this node

title: Set Exchange Pattern

description: Sets the exchange pattern on the message exchange

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Pattern

description: Sets the new exchange pattern of the Exchange to be used from this point forward

title: Set Header

description: Sets the value of a message header

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to return the value of the header

title: Id

description: Sets the id of this node

title: Name

description: Name of message header to set a new value The simple language can be used to define a dynamic evaluated header name to be used. Otherwise a constant name will be used.

title: Set Property

description: Sets a named property on the message exchange

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to return the value of the message exchange property

title: Id

description: Sets the id of this node

title: Name

description: Name of exchange property to set a new value. The simple language can be used to define a dynamic evaluated exchange property name to be used. Otherwise a constant name will be used.

title: Sort

description: Sorts the contents of the message

title: Comparator

description: Sets the comparator to use for sorting

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Optional expression to sort by something else than the message body

title: Id

description: Sets the id of this node

title: Split

description: Splits a single message into many sub-messages.

title: Aggregation Strategy

description: Sets a reference to the AggregationStrategy to be used to assemble the replies from the split messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

title: Aggregation Strategy Method Allow Null

title: Aggregation Strategy Method Name

title: Delimiter

description: Delimiter used in splitting messages. Can be turned off using the value false. The default value is ,

title: Id

description: Sets the id of this node

title: Disabled

title: Executor Service

description: To use a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatically implied, and you do not have to enable that option as well.

title: Expression

description: Expression of how to split the message body, such as as-is, using a tokenizer, or using a xpath.

title: Id

description: Sets the id of this node

title: On Prepare

description: Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.

title: Parallel Aggregate

title: Parallel Processing

description: If enabled then processing each split messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. It's only processing the sub messages from the splitter which happens concurrently. When parallel processing is enabled, then the Camel routing engin will continue processing using last used thread from the parallel thread pool. However, if you want to use the original thread that called the splitter, then make sure to enable the synchronous option as well.

title: Share Unit Of Work

description: Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Splitter will by default not share unit of work between the parent exchange and each split exchange. This means each split exchange has its own individual unit of work.

title: Stop On Exception

description: Will now stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the splitter will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine. The default behavior is to not stop but continue processing till the end

title: Streaming

description: When in streaming mode, then the splitter splits the original message on-demand, and each split message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the org.apache.camel.Exchange#SPLIT_SIZE is empty. In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the split messages in memory and therefore requires more memory. The total size is provided in the org.apache.camel.Exchange#SPLIT_SIZE header. The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, e.g. in the order they come back. If disabled, Camel will process replies in the same order as the messages was split.

title: Synchronous

description: Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the split is complete, even if parallel processing is enabled.

title: Timeout

description: Sets a total timeout specified in millis, when using parallel processing. If the Splitter hasn't been able to split and process all the sub messages within the given timeframe, then the timeout triggers and the Splitter breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.

title: Step

description: Routes the message to a sequence of processors which is grouped together as one logical name

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Stop

description: Stops the processing of the current message

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Templated Route Parameter

description: An input parameter of a route template.

title: Name

description: The name of the parameter

title: Value

description: The value of the parameter.

title: Thread Pool Profile

description: To configure thread pools

title: Allow Core Thread Time Out

description: Whether idle core threads is allowed to timeout and therefore can shrink the pool size below the core pool size Is by default true

title: Default Profile

description: Whether this profile is the default thread pool profile

title: Id

description: Sets the id of this node

title: Id

description: Sets the id of this node

title: Keep Alive Time

description: Sets the keep alive time for idle threads in the pool

title: Max Pool Size

description: Sets the maximum pool size

title: Max Queue Size

description: Sets the maximum number of tasks in the work queue. Use -1 or Integer.MAX_VALUE for an unbounded queue

title: Pool Size

description: Sets the core pool size

title: Rejected Policy

description: Sets the handler for tasks which cannot be executed by the thread pool.

title: Time Unit

description: Sets the time unit to use for keep alive time By default SECONDS is used.

enum: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS

title: Threads

description: Specifies that all steps after this node are processed asynchronously

title: Allow Core Thread Time Out

description: Whether idle core threads are allowed to timeout and therefore can shrink the pool size below the core pool size Is by default false

title: Caller Runs When Rejected

description: Whether or not to use as caller runs as fallback when a task is rejected being added to the thread pool (when its full). This is only used as fallback if no rejectedPolicy has been configured, or the thread pool has no configured rejection handler. Is by default true

title: Id

description: Sets the id of this node

title: Disabled

title: Executor Service

description: To use a custom thread pool

title: Id

description: Sets the id of this node

title: Keep Alive Time

description: Sets the keep alive time for idle threads

title: Max Pool Size

description: Sets the maximum pool size

title: Max Queue Size

title: Pool Size

description: Sets the core pool size

title: Rejected Policy

title: Thread Name

description: Sets the thread name to use.

title: Time Unit

description: Sets the keep alive time unit. By default SECONDS is used.

title: Throttle

description: Controls the rate at which messages are passed to the next node in the route

title: Async Delayed

title: Caller Runs When Rejected

title: Correlation Expression

description: The expression used to calculate the correlation key to use for throttle grouping. The Exchange which has the same correlation key is throttled together.

title: Id

description: Sets the id of this node

title: Disabled

title: Executor Service

description: To use a custom thread pool (ScheduledExecutorService) by the throttler.

title: Expression

description: Expression to configure the maximum number of messages to throttle per request

title: Id

description: Sets the id of this node

title: Reject Execution

description: Whether or not throttler throws the ThrottlerRejectedExecutionException when the exchange exceeds the request limit Is by default false

title: Time Period Millis

description: Sets the time period during which the maximum request count is valid for

title: Throw Exception

description: Throws an exception

title: Id

description: Sets the id of this node

title: Disabled

title: Exception Type

description: The class of the exception to create using the message.

title: Id

description: Sets the id of this node

title: Message

description: To create a new exception instance and use the given message as caused message (supports simple language)

title: Ref

description: Reference to the exception instance to lookup from the registry to throw

title: To

description: Sends the message to a static endpoint

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Pattern

description: Sets the optional ExchangePattern used to invoke this endpoint

title: Uri

description: Sets the uri of the endpoint to send to.

title: To D

description: Sends the message to a dynamic endpoint

title: Allow Optimised Components

description: Whether to allow components to optimise toD if they are org.apache.camel.spi.SendDynamicAware .

title: Auto Start Components

description: Whether to auto startup components when toD is starting up.

title: Cache Size

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Ignore Invalid Endpoint

description: Whether to ignore invalid endpoint URIs and skip sending the message.

title: Pattern

title: Uri

description: The uri of the endpoint to send to. The uri can be dynamic computed using the org.apache.camel.language.simple.SimpleLanguage expression.

title: Transacted

description: Enables transaction on the route

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Ref

title: Transform

description: Transforms the message body based on an expression

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

title: From Type

description: From type used in data type transformation.

title: Id

description: Sets the id of this node

title: To Type

description: To type used as a target data type in the transformation.

title: Do Try

description: Marks the beginning of a try, catch, finally block

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Unmarshal

description: Converts the message data received from the wire into a format that Apache Camel processors can consume

title: Allow Null Body

description: Indicates whether null is allowed as value of a body to unmarshall.

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Validate

description: Validates a message based on an expression

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression to use for validation as a predicate. The expression should return either true or false. If returning false the message is invalid and an exception is thrown.

title: Id

description: Sets the id of this node

title: Predicate Exception Factory

description: The bean id of custom PredicateExceptionFactory to use for creating the exception when the validation fails. By default, Camel will throw PredicateValidationException. By using a custom factory you can control which exception to throw instead.

title: Value

description: A single value

title: Value

description: Property value

title: When

description: Triggers a route when the expression evaluates to true

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression used as the predicate to evaluate whether this when should trigger and route the message or not.

title: Id

description: Sets the id of this node

title: When Skip Send To Endpoint

description: Predicate to determine if the message should be sent or not to the endpoint, when using interceptSentToEndpoint.

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

description: Expression used as the predicate to evaluate whether the message should be sent or not to the endpoint

title: Id

description: Sets the id of this node

title: Wire Tap

description: Routes a copy of a message (or creates a new message) to a secondary destination while continue routing the original message.

title: Allow Optimised Components

title: Auto Start Components

title: Cache Size

title: Copy

description: Uses a copy of the original exchange

title: Id

description: Sets the id of this node

title: Disabled

title: Dynamic Uri

description: Whether the uri is dynamic or static. If the uri is dynamic then the simple language is used to evaluate a dynamic uri to use as the wire-tap destination, for each incoming message. This works similar to how the toD EIP pattern works. If static then the uri is used as-is as the wire-tap destination.

title: Executor Service

description: Uses a custom thread pool

title: Id

description: Sets the id of this node

title: Ignore Invalid Endpoint

title: On Prepare

title: Pattern

title: Uri

title: Camel

description: If beans reminds Spring application too much, we can use camel.

title: Bean

title: Rest

title: Rest Configuration

title: Route

title: Route Configuration

title: Route Template

title: Templated Route

title: Beans

description: A grouping POJO (and related XML root element) that's historically associated with entire application (or its distinguished fragment). This class is not meant to be used with Camel Java DSL, but it's needed to generate XML Schema and MX parser methods.

title: Bean

title: Rest

title: Rest Configuration

title: Route

title: Route Configuration

title: Route Template

title: Templated Route

title: Blacklist Service Filter

title: Id

description: The id of this node

title: Properties

description: Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.

title: Servers

description: Sets the server blacklist. Each entry can be a list of servers separated by comma in the format: servicehost:port,servicehost2:port,servicehost3:port

title: Caching Service Discovery

title: Id

description: The id of this node

title: Properties

title: Timeout

description: Set the time the services will be retained.

title: Units

description: Set the time unit for the timeout.

title: Combined Service Discovery

title: Id

description: The id of this node

title: Properties

title: Combined Service Filter

title: Id

description: The id of this node

title: Properties

title: Consul Service Discovery

title: Acl Token

description: Sets the ACL token to be used with Consul

title: Block Seconds

description: The seconds to wait for a watch event, default 10 seconds

title: Connect Timeout Millis

description: Connect timeout for OkHttpClient

title: Datacenter

description: The data center

title: Id

description: The id of this node

title: Password

description: Sets the password to be used for basic authentication

title: Properties

title: Read Timeout Millis

description: Read timeout for OkHttpClient

title: Url

description: The Consul agent URL

title: User Name

description: Sets the username to be used for basic authentication

title: Write Timeout Millis

description: Write timeout for OkHttpClient

title: Custom Service Filter

title: Id

description: The id of this node

title: Properties

title: Ref

description: Reference of a ServiceFilter

title: Default Load Balancer

title: Id

description: The id of this node

title: Properties

title: Dns Service Discovery

title: Domain

description: The domain name;

title: Id

description: The id of this node

title: Properties

title: Proto

description: The transport protocol of the desired service.

title: Healthy Service Filter

title: Id

description: The id of this node

title: Properties

title: Kubernetes Service Discovery

title: Api Version

description: Sets the API version when using client lookup

title: Ca Cert Data

description: Sets the Certificate Authority data when using client lookup

title: Ca Cert File

description: Sets the Certificate Authority data that are loaded from the file when using client lookup

title: Client Cert Data

description: Sets the Client Certificate data when using client lookup

title: Client Cert File

description: Sets the Client Certificate data that are loaded from the file when using client lookup

title: Client Key Algo

description: Sets the Client Keystore algorithm, such as RSA when using client lookup

title: Client Key Data

description: Sets the Client Keystore data when using client lookup

title: Client Key File

description: Sets the Client Keystore data that are loaded from the file when using client lookup

title: Client Key Passphrase

description: Sets the Client Keystore passphrase when using client lookup

title: Dns Domain

description: Sets the DNS domain to use for DNS lookup.

title: Id

description: The id of this node

title: Lookup

description: How to perform service lookup. Possible values: client, dns, environment. When using client, then the client queries the kubernetes master to obtain a list of active pods that provides the service, and then random (or round robin) select a pod. When using dns the service name is resolved as name.namespace.svc.dnsDomain. When using dnssrv the service name is resolved with SRV query for _._...svc... When using environment then environment variables are used to lookup the service. By default environment is used.

title: Master Url

description: Sets the URL to the master when using client lookup

title: Namespace

description: Sets the namespace to use. Will by default use namespace from the ENV variable KUBERNETES_MASTER.

title: Oauth Token

description: Sets the OAUTH token for authentication (instead of username/password) when using client lookup

title: Password

description: Sets the password for authentication when using client lookup

title: Port Name

description: Sets the Port Name to use for DNS/DNSSRV lookup.

title: Port Protocol

description: Sets the Port Protocol to use for DNS/DNSSRV lookup.

title: Properties

title: Trust Certs

description: Sets whether to turn on trust certificate check when using client lookup

title: Username

description: Sets the username for authentication when using client lookup

title: Pass Through Service Filter

title: Id

description: The id of this node

title: Properties

title: Service Call Configuration

description: Remote service call configuration

title: Component

description: The component to use.

title: Expression

description: Configures the Expression using the given configuration.

title: Expression Ref

description: Set a reference to a custom Expression to use.

title: Id

description: The id of this node

title: Load Balancer Ref

description: Sets a reference to a custom ServiceLoadBalancer to use.

title: Pattern

title: Service Chooser Ref

description: Sets a reference to a custom ServiceChooser to use.

title: Service Discovery Ref

description: Sets a reference to a custom ServiceDiscovery to use.

title: Service Filter Ref

description: Sets a reference to a custom ServiceFilter to use.

title: Uri

description: The uri of the endpoint to send to. The uri can be dynamic computed using the simple language expression.

title: Service Call

description: To call remote services

title: Component

description: The component to use.

title: Configuration Ref

description: Refers to a ServiceCall configuration to use

title: Id

description: Sets the id of this node

title: Disabled

title: Expression

title: Expression Ref

title: Id

description: Sets the id of this node

title: Load Balancer Ref

title: Name

description: Sets the name of the service to use

title: Pattern

title: Service Chooser Ref

title: Service Discovery Ref

title: Service Filter Ref

title: Uri

title: Service Expression

title: Host Header

description: The header that holds the service host information, default ServiceCallConstants.SERVICE_HOST

title: Id

description: The id of this node

title: Port Header

description: The header that holds the service port information, default ServiceCallConstants.SERVICE_PORT

title: Properties

title: Service Chooser Configuration

title: Id

description: The id of this node

title: Properties

title: Service Discovery Configuration

title: Id

description: The id of this node

title: Properties

title: Service Filter Configuration

title: Id

description: The id of this node

title: Properties

title: Load Balancer Configuration

title: Id

description: The id of this node

title: Properties

title: Static Service Discovery

title: Id

description: The id of this node

title: Properties

title: Servers

description: Sets the server list. Each entry can be a list of servers separated by comma in the format: servicehost:port,servicehost2:port,servicehost3:port

title: Zookeeper Service Discovery

title: Base Path

description: Set the base path to store in ZK

title: Connection Timeout

description: Connection timeout.

title: Id

description: The id of this node

title: Namespace

description: As ZooKeeper is a shared space, users of a given cluster should stay within a pre-defined namespace. If a namespace is set here, all paths will get pre-pended with the namespace

title: Nodes

description: A comma separate list of servers to connect to in the form host:port

title: Properties

title: Reconnect Base Sleep Time

description: Initial amount of time to wait between retries.

title: Reconnect Max Retries

description: Max number of times to retry

title: Reconnect Max Sleep Time

description: Max time in ms to sleep on each retry

title: Session Timeout

description: Session timeout.

title: Batch-config

description: Configures batch-processing resequence eip.

title: Allow Duplicates

description: Whether to allow duplicates.

title: Batch Size

description: Sets the size of the batch to be re-ordered. The default size is 100.

title: Batch Timeout

description: Sets the timeout for collecting elements to be re-ordered. The default timeout is 1000 msec.

title: Ignore Invalid Exchanges

description: Whether to ignore invalid exchanges

title: Reverse

description: Whether to reverse the ordering.

title: Stream-config

description: Configures stream-processing resequence eip.

title: Capacity

description: Sets the capacity of the resequencer inbound queue.

title: Comparator

description: To use a custom comparator as a org.apache.camel.processor.resequencer.ExpressionResultComparator type.

title: Delivery Attempt Interval

description: Sets the interval in milliseconds the stream resequencer will at most wait while waiting for condition of being able to deliver.

title: Ignore Invalid Exchanges

description: Whether to ignore invalid exchanges

title: Reject Old

description: If true, throws an exception when messages older than the last delivered message are processed

title: Timeout

description: Sets minimum time (milliseconds) to wait for missing elements (messages).

title: ASN.1 File

description: Encode and decode data structures using Abstract Syntax Notation One (ASN.1).

title: Id

description: The id of this node

title: Unmarshal Type

description: Class to use when unmarshalling.

title: Using Iterator

description: If the asn1 file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode.

title: Avro

description: Serialize and deserialize messages using Apache Avro binary data format.

title: Allow Jms Type

description: Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.

title: Allow Unmarshall Type

description: If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.

title: Auto Discover Object Mapper

description: If set to true then Jackson will lookup for an objectMapper into the registry

title: Auto Discover Schema Resolver

description: When not disabled, the SchemaResolver will be looked up into the registry

title: Collection Type

description: Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.

title: Content Type Header

description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON

title: Disable Features

description: Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma

title: Enable Features

description: Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma

title: Id

description: The id of this node

title: Include

description: If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL

title: Instance Class Name

description: Class name to use for marshal and unmarshalling

title: Json View

description: When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations

title: Library

description: Which Avro library to use.

title: Module Class Names

description: To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma.

title: Module Refs

description: To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.

title: Object Mapper

description: Lookup and use the existing ObjectMapper with the given id when using Jackson.

title: Schema Resolver

description: Optional schema resolver used to lookup schemas for the data in transit.

title: Timezone

description: If set then Jackson will use the Timezone when marshalling/unmarshalling.

title: Unmarshal Type

description: Class name of the java type to use when unmarshalling

title: Use Default Object Mapper

description: Whether to lookup and use default Jackson ObjectMapper from the registry.

title: Use List

description: To unmarshal to a List of Map or a List of Pojo.

title: Barcode

description: Transform strings to various 1D/2D barcode bitmap formats and back.

title: Barcode Format

description: Barcode format such as QR-Code

title: Height

description: Height of the barcode

title: Id

description: The id of this node

title: Image Type

description: Image type of the barcode such as png

title: Width

description: Width of the barcode

title: Base64

description: Encode and decode data using Base64.

title: Id

description: The id of this node

title: Line Length

description: To specific a maximum line length for the encoded data. By default 76 is used.

title: Line Separator

description: The line separators to use. Uses new line characters (CRLF) by default.

title: Url Safe

description: Instead of emitting '' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode operations. Decoding seamlessly handles both modes. Is by default false.

title: Bindy

description: Marshal and unmarshal Java beans from and to flat payloads (such as CSV, delimited, fixed length formats, or FIX messages).

title: Allow Empty Stream

description: Whether to allow empty streams in the unmarshal process. If true, no exception will be thrown when a body without records is provided.

title: Class Type

description: Name of model class to use.

title: Id

description: The id of this node

title: Locale

description: To configure a default locale to use, such as us for united states. To use the JVM platform default locale then use the name default

title: Type

description: Whether to use Csv, Fixed, or KeyValue.

title: Unwrap Single Instance

description: When unmarshalling should a single instance be unwrapped and returned instead of wrapped in a java.util.List.

title: CBOR

description: Unmarshal a CBOR payload to POJO and back.

title: Allow Jms Type

title: Allow Unmarshall Type

description: If enabled then Jackson CBOR is allowed to attempt to use the CamelCBORUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.

title: Collection Type

title: Disable Features

title: Enable Features

title: Id

description: The id of this node

title: Object Mapper

description: Lookup and use the existing CBOR ObjectMapper with the given id when using Jackson.

title: Pretty Print

description: To enable pretty printing output nicely formatted. Is by default false.

title: Unmarshal Type

title: Use Default Object Mapper

description: Whether to lookup and use default Jackson CBOR ObjectMapper from the registry.

title: Use List

title: Crypto (Java Cryptographic Extension)

description: Encrypt and decrypt messages using Java Cryptography Extension (JCE).

title: Algorithm

description: The JCE algorithm name indicating the cryptographic algorithm that will be used.

title: Algorithm Parameter Ref

description: A JCE AlgorithmParameterSpec used to initialize the Cipher. Will lookup the type using the given name as a java.security.spec.AlgorithmParameterSpec type.

title: Buffer Size

description: The size of the buffer used in the signature process.

title: Crypto Provider

description: The name of the JCE Security Provider that should be used.

title: Id

description: The id of this node

title: Init Vector Ref

description: Refers to a byte array containing the Initialization Vector that will be used to initialize the Cipher.

title: Inline

description: Flag indicating that the configured IV should be inlined into the encrypted data stream. Is by default false.

title: Key Ref

description: Refers to the secret key to lookup from the register to use.

title: Mac Algorithm

description: The JCE algorithm name indicating the Message Authentication algorithm.

title: CSV

description: Handle CSV (Comma Separated Values) payloads.

title: Allow Missing Column Names

description: Whether to allow missing column names.

title: Capture Header Record

description: Whether the unmarshalling should capture the header record and store it in the message header

title: Comment Marker

description: Sets the comment marker of the reference format.

title: Comment Marker Disabled

description: Disables the comment marker of the reference format.

title: Delimiter

description: Sets the delimiter to use. The default value is , (comma)

title: Escape

description: Sets the escape character to use

title: Escape Disabled

description: Use for disabling using escape character

title: Format Name

description: The name of the format to use, the default value is CSVFormat.DEFAULT

title: Format Ref

description: The reference format to use, it will be updated with the other format options, the default value is CSVFormat.DEFAULT

title: Header

description: To configure the CSV headers

title: Header Disabled

description: Use for disabling headers

title: Id

description: The id of this node

title: Ignore Empty Lines

description: Whether to ignore empty lines.

title: Ignore Header Case

description: Sets whether or not to ignore case when accessing header names.

title: Ignore Surrounding Spaces

description: Whether to ignore surrounding spaces

title: Lazy Load

description: Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one.

title: Marshaller Factory Ref

description: Sets the implementation of the CsvMarshallerFactory interface which is able to customize marshalling/unmarshalling behavior by extending CsvMarshaller or creating it from scratch.

title: Null String

description: Sets the null string

title: Null String Disabled

description: Used to disable null strings

title: Quote

description: Sets the quote which by default is

title: Quote Disabled

description: Used to disable quotes

title: Quote Mode

description: Sets the quote mode

title: Record Converter Ref

description: Refers to a custom CsvRecordConverter to lookup from the registry to use.

title: Record Separator

description: Sets the record separator (aka new line) which by default is new line characters (CRLF)

title: Record Separator Disabled

description: Used for disabling record separator

title: Skip Header Record

description: Whether to skip the header record in the output

title: Trailing Delimiter

description: Sets whether or not to add a trailing delimiter.

title: Trim

description: Sets whether or not to trim leading and trailing blanks.

title: Use Maps

description: Whether the unmarshalling should produce maps (HashMap)for the lines values instead of lists. It requires to have header (either defined or collected).

title: Use Ordered Maps

description: Whether the unmarshalling should produce ordered maps (LinkedHashMap) for the lines values instead of lists. It requires to have header (either defined or collected).

title: Custom

description: Delegate to a custom org.apache.camel.spi.DataFormat implementation via Camel registry.

title: Id

description: The id of this node

title: Ref

description: Reference to the custom org.apache.camel.spi.DataFormat to lookup from the Camel registry.

title: Data formats

description: Configure data formats.

title: FHIR JSon

description: Marshall and unmarshall FHIR objects to/from JSON.

title: Content Type Header

title: Dont Encode Elements

description: If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Don't encode patient and all its children Patient.name - Don't encode the patient's name Patient.name.family - Don't encode the patient's family name .text - Don't encode the text element on any resource (only the very first position may contain a wildcard) DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3 mode.

title: Dont Strip Versions From References At Paths

description: If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process. Multiple elements can be separated by comma when using String parameter. This method provides a finer-grained level of control than setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(String) has been set to true (which is the default)

title: Encode Elements

description: If provided, specifies the elements which should be encoded, to the exclusion of all others. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Encode patient and all its children Patient.name - Encode only the patient's name Patient.name.family - Encode only the patient's family name .text - Encode the text element on any resource (only the very first position may contain a wildcard) .(mandatory) - This is a special case which causes any mandatory fields (min 0) to be encoded

title: Encode Elements Applies To Child Resources Only

description: If set to true (default is false), the values supplied to setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)

title: Fhir Context

description: To use a custom fhir context. Reference to object of type ca.uhn.fhir.context.FhirContext

title: Fhir Version

description: The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4,R5

title: Force Resource Id

description: When encoding, force this resource ID to be encoded as the resource ID. Reference to object of type org.hl7.fhir.instance.model.api.IIdType

title: Id

description: The id of this node

title: Omit Resource Id

description: If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID.

title: Override Resource Id With Bundle Entry Full Url

description: If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id).

title: Parser Error Handler

description: Registers an error handler which will be invoked when any parse errors are found. Reference to object of type ca.uhn.fhir.parser.IParserErrorHandler

title: Parser Options

description: Sets the parser options object which will be used to supply default options to newly created parsers. Reference to object of type ca.uhn.fhir.context.ParserOptions.

title: Prefer Types

description: If set (FQN class names), when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority). For example, if a custom type which declares to implement the Patient resource is passed in here, and the parser is parsing a Bundle containing a Patient resource, the parser will use the given custom type. Multiple class names can be separated by comma.

title: Pretty Print

description: Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible.

title: Server Base Url

description: Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base.

title: Strip Versions From References

description: If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false. This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use setDontStripVersionsFromReferencesAtPaths(List)

title: Summary Mode

description: If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included.

title: Suppress Narratives

description: If set to true (default is false), narratives will not be included in the encoded values.

title: FHIR XML

description: Marshall and unmarshall FHIR objects to/from XML.

title: Content Type Header

title: Dont Encode Elements

title: Encode Elements

title: Fhir Context

title: Fhir Version

title: Force Resource Id

title: Id

description: The id of this node

title: Omit Resource Id

title: Parser Error Handler

title: Parser Options

title: Prefer Types

title: Pretty Print

title: Server Base Url

title: Strip Versions From References

title: Summary Mode

title: Suppress Narratives

title: Flatpack

description: Marshal and unmarshal Java lists and maps to/from flat files (such as CSV, delimited, or fixed length formats) using Flatpack library.

title: Allow Short Lines

description: Allows for lines to be shorter than expected and ignores the extra characters

title: Definition

description: The flatpack pzmap configuration file. Can be omitted in simpler situations, but its preferred to use the pzmap.

title: Delimiter

description: The delimiter char (could be ; , or similar)

title: Fixed

description: Delimited or fixed. Is by default false = delimited

title: Id

description: The id of this node

title: Ignore Extra Columns

description: Allows for lines to be longer than expected and ignores the extra characters.

title: Ignore First Record

description: Whether the first line is ignored for delimited files (for the column headers). Is by default true.

title: Parser Factory Ref

description: References to a custom parser factory to lookup in the registry

title: Text Qualifier

description: If the text is qualified with a character. Uses quote character by default.

title: Grok

description: Unmarshal unstructured data to objects using Logstash based Grok patterns.

title: Allow Multiple Matches Per Line

description: If false, every line of input is matched for pattern only once. Otherwise the line can be scanned multiple times when non-terminal pattern is used.

title: Flattened

description: Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key.

title: Id

description: The id of this node

title: Named Only

description: Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})

title: Pattern

description: The grok pattern to match lines of input

title: GZip Deflater

description: Compress and decompress messages using java.util.zip.GZIPStream.

title: Id

description: The id of this node

title: HL7

description: Marshal and unmarshal HL7 (Health Care) model objects using the HL7 MLLP codec.

title: Id

description: The id of this node

title: Validate

description: Whether to validate the HL7 message Is by default true.

title: iCal

description: Marshal and unmarshal iCal (.ics) documents to/from model objects.

title: Id

description: The id of this node

title: Validating

description: Whether to validate.

title: Jackson XML

description: Unmarshal an XML payloads to POJOs and back using XMLMapper extension of Jackson.

title: Allow Jms Type

title: Allow Unmarshall Type

title: Collection Type

title: Content Type Header

title: Disable Features

title: Enable Features

title: Enable Jaxb Annotation Module

description: Whether to enable the JAXB annotations module when using jackson. When enabled then JAXB annotations can be used by Jackson.

title: Id

description: The id of this node

title: Include

title: Json View

title: Module Class Names

title: Module Refs

title: Pretty Print

title: Timezone

title: Unmarshal Type

title: Use List

title: Xml Mapper

description: Lookup and use the existing XmlMapper with the given id.

title: JAXB

description: Unmarshal XML payloads to POJOs and back using JAXB2 XML marshalling standard.

title: Access External Schema Protocols

description: Only in use if schema validation has been enabled. Restrict access to the protocols specified for external reference set by the schemaLocation attribute, Import and Include element. Examples of protocols are file, http, jar:file. false or none to deny all access to external references; a specific protocol, such as file, to give permission to only the protocol; the keyword all to grant permission to all protocols.

title: Content Type Header

title: Context Path

description: Package name where your JAXB classes are located.

title: Context Path Is Class Name

description: This can be set to true to mark that the contextPath is referring to a classname and not a package name.

title: Encoding

description: To overrule and use a specific encoding

title: Filter Non Xml Chars

description: To ignore non xml characheters and replace them with an empty space.

title: Fragment

description: To turn on marshalling XML fragment trees. By default JAXB looks for XmlRootElement annotation on given class to operate on whole XML tree. This is useful but not always - sometimes generated code does not have XmlRootElement annotation, sometimes you need unmarshall only part of tree. In that case you can use partial unmarshalling. To enable this behaviours you need set property partClass. Camel will pass this class to JAXB's unmarshaler.

title: Id

description: The id of this node

title: Jaxb Provider Properties

description: Refers to a custom java.util.Map to lookup in the registry containing custom JAXB provider properties to be used with the JAXB marshaller.

title: Namespace Prefix Ref

description: When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To control this mapping, Camel allows you to refer to a map which contains the desired mapping.

title: No Namespace Schema Location

description: To define the location of the namespaceless schema

title: Object Factory

description: Whether to allow using ObjectFactory classes to create the POJO classes during marshalling. This only applies to POJO classes that has not been annotated with JAXB and providing jaxb.index descriptor files.

title: Part Class

description: Name of class used for fragment parsing. See more details at the fragment option.

title: Part Namespace

description: XML namespace to use for fragment parsing. See more details at the fragment option.

title: Pretty Print

title: Schema

description: To validate against an existing schema. Your can use the prefix classpath:, file: or http: to specify how the resource should be resolved. You can separate multiple schema files by using the ',' character.

title: Schema Location

description: To define the location of the schema

title: Schema Severity Level

description: Sets the schema severity level to use when validating against a schema. This level determines the minimum severity error that triggers JAXB to stop continue parsing. The default value of 0 (warning) means that any error (warning, error or fatal error) will trigger JAXB to stop. There are the following three levels: 0=warning, 1=error, 2=fatal error.

title: Xml Stream Writer Wrapper

description: To use a custom xml stream writer.

title: JSonApi

description: Marshal and unmarshal JSON:API resources using JSONAPI-Converter library.

title: Data Format Types

description: The classes to take into account for the marshalling. Multiple classes can be separated by comma.

title: Id

description: The id of this node

title: Main Format Type

description: The class to take into account while unmarshalling.

title: JSon

description: Marshal POJOs to JSON and back.

title: Allow Jms Type

title: Allow Unmarshall Type

title: Auto Discover Object Mapper

description: If set to true then Jackson will look for an objectMapper to use from the registry

title: Auto Discover Schema Resolver

title: Collection Type

description: Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows using different collection types than java.util.Collection based as default.

title: Content Type Header

title: Date Format Pattern

description: To configure the date format while marshall or unmarshall Date fields in JSON using Gson

title: Disable Features

title: Enable Features

title: Id

description: The id of this node

title: Include

title: Json View

title: Library

description: Which json library to use.

title: Module Class Names

title: Module Refs

title: Naming Strategy

description: If set then Jackson will use the the defined Property Naming Strategy.Possible values are: LOWER_CAMEL_CASE, LOWER_DOT_CASE, LOWER_CASE, KEBAB_CASE, SNAKE_CASE and UPPER_CAMEL_CASE

title: Object Mapper

title: Pretty Print

title: Schema Resolver

title: Timezone

description: If set then Jackson will use the Timezone when marshalling/unmarshalling. This option will have no effect on the others Json DataFormat, like gson and fastjson.

title: Unmarshal Type

title: Use Default Object Mapper

title: Use List

title: LZF Deflate Compression

description: Compress and decompress streams using LZF deflate algorithm.

title: Id

description: The id of this node

title: Using Parallel Compression

description: Enable encoding (compress) using multiple processing cores.

title: MIME Multipart

description: Marshal Camel messages with attachments into MIME-Multipart messages and back.

title: Binary Content

description: Defines whether the content of binary parts in the MIME multipart is binary (true) or Base-64 encoded (false) Default is false.

title: Headers Inline

description: Defines whether the MIME-Multipart headers are part of the message body (true) or are set as Camel headers (false). Default is false.

title: Id

description: The id of this node

title: Include Headers

description: A regex that defines which Camel headers are also included as MIME headers into the MIME multipart. This will only work if headersInline is set to true. Default is to include no headers

title: Multipart Sub Type

description: Specify the subtype of the MIME Multipart. Default is mixed.

title: Multipart Without Attachment

description: Defines whether a message without attachment is also marshaled into a MIME Multipart (with only one body part). Default is false.

title: PGP

description: Encrypt and decrypt messages using Java Cryptographic Extension (JCE) and PGP.

title: Algorithm

description: Symmetric key encryption algorithm; possible values are defined in org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags; for example 2 (= TRIPLE DES), 3 (= CAST5), 4 (= BLOWFISH), 6 (= DES), 7 (= AES_128). Only relevant for encrypting.

title: Armored

description: This option will cause PGP to base64 encode the encrypted text, making it available for copy/paste, etc.

title: Compression Algorithm

description: Compression algorithm; possible values are defined in org.bouncycastle.bcpg.CompressionAlgorithmTags; for example 0 (= UNCOMPRESSED), 1 (= ZIP), 2 (= ZLIB), 3 (= BZIP2). Only relevant for encrypting.

title: Hash Algorithm

description: Signature hash algorithm; possible values are defined in org.bouncycastle.bcpg.HashAlgorithmTags; for example 2 (= SHA1), 8 (= SHA256), 9 (= SHA384), 10 (= SHA512), 11 (=SHA224). Only relevant for signing.

title: Id

description: The id of this node

title: Integrity

description: Adds an integrity check/sign into the encryption file. The default value is true.

title: Key File Name

description: Filename of the keyring; must be accessible as a classpath resource (but you can specify a location in the file system by using the file: prefix).

title: Key Userid

description: The user ID of the key in the PGP keyring used during encryption. Can also be only a part of a user ID. For example, if the user ID is Test User then you can use the part Test User or to address the user ID.

title: Password

description: Password used when opening the private key (not used for encryption).

title: Provider

description: Java Cryptography Extension (JCE) provider, default is Bouncy Castle (BC). Alternatively you can use, for example, the IAIK JCE provider; in this case the provider must be registered beforehand and the Bouncy Castle provider must not be registered beforehand. The Sun JCE provider does not work.

title: Signature Key File Name

description: Filename of the keyring to use for signing (during encryption) or for signature verification (during decryption); must be accessible as a classpath resource (but you can specify a location in the file system by using the file: prefix).

title: Signature Key Ring

description: Keyring used for signing/verifying as byte array. You can not set the signatureKeyFileName and signatureKeyRing at the same time.

title: Signature Key Userid

description: User ID of the key in the PGP keyring used for signing (during encryption) or signature verification (during decryption). During the signature verification process the specified User ID restricts the public keys from the public keyring which can be used for the verification. If no User ID is specified for the signature verficiation then any public key in the public keyring can be used for the verification. Can also be only a part of a user ID. For example, if the user ID is Test User then you can use the part Test User or to address the User ID.

title: Signature Password

description: Password used when opening the private key used for signing (during encryption).

title: Signature Verification Option

description: Controls the behavior for verifying the signature during unmarshaling. There are 4 values possible: optional: The PGP message may or may not contain signatures; if it does contain signatures, then a signature verification is executed. required: The PGP message must contain at least one signature; if this is not the case an exception (PGPException) is thrown. A signature verification is executed. ignore: Contained signatures in the PGP message are ignored; no signature verification is executed. no_signature_allowed: The PGP message must not contain a signature; otherwise an exception (PGPException) is thrown.

title: Parquet File

description: Parquet Avro serialization and de-serialization.

title: Compression Codec Name

description: Compression codec to use when marshalling.

title: Id

description: The id of this node

title: Unmarshal Type

description: Class to use when (un)marshalling. If omitted, parquet files are converted into Avro's GenericRecords for unmarshalling and input objects are assumed as GenericRecords for marshalling.

title: Protobuf

description: Serialize and deserialize Java objects using Google's Protocol buffers.

title: Allow Jms Type

title: Allow Unmarshall Type

title: Auto Discover Object Mapper

title: Auto Discover Schema Resolver

title: Collection Type

title: Content Type Format

description: Defines a content type format in which protobuf message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native protobuf or json fields representation. The default value is native.

title: Content Type Header

title: Disable Features

title: Enable Features

title: Id

description: The id of this node

title: Include

title: Instance Class

description: Name of class to use when unmarshalling

title: Json View

title: Library

description: Which Protobuf library to use.

title: Module Class Names

title: Module Refs

title: Object Mapper

title: Schema Resolver

title: Timezone

title: Unmarshal Type

title: Use Default Object Mapper

title: Use List

title: RSS

description: Transform from ROME SyndFeed Java Objects to XML and vice-versa.

title: Id

description: The id of this node

title: SOAP

description: Marshal Java objects to SOAP messages and back.

title: Context Path

title: Element Name Strategy Ref

description: Refers to an element strategy to lookup from the registry. An element name strategy is used for two purposes. The first is to find a xml element name for a given object and soap action when marshaling the object into a SOAP message. The second is to find an Exception class for a given soap fault name. The following three element strategy class name is provided out of the box. QNameStrategy - Uses a fixed qName that is configured on instantiation. Exception lookup is not supported TypeNameStrategy - Uses the name and namespace from the XMLType annotation of the given type. If no namespace is set then package-info is used. Exception lookup is not supported ServiceInterfaceStrategy - Uses information from a webservice interface to determine the type name and to find the exception class for a SOAP fault All three classes is located in the package name org.apache.camel.dataformat.soap.name If you have generated the web service stub code with cxf-codegen or a similar tool then you probably will want to use the ServiceInterfaceStrategy. In the case you have no annotated service interface you should use QNameStrategy or TypeNameStrategy.

title: Encoding

description: To overrule and use a specific encoding

title: Id

description: The id of this node

title: Namespace Prefix Ref

title: Schema

title: Version

description: SOAP version should either be 1.1 or 1.2. Is by default 1.1

title: SWIFT MT

description: Encode and decode SWIFT MT messages.

title: Id

description: The id of this node

title: Write In Json

description: The flag indicating that messages must be marshalled in a JSON format.

title: SWIFT MX

description: Encode and decode SWIFT MX messages.

title: Id

description: The id of this node

title: Read Config Ref

description: Refers to a specific configuration to use when unmarshalling an input stream to lookup from the registry.

title: Read Message Id

description: The type of MX message to produce when unmarshalling an input stream. If not set, it will be automatically detected from the namespace used.

title: Write Config Ref

description: Refers to a specific configuration to use when marshalling a message to lookup from the registry.

title: Write In Json

title: Syslog

description: Marshall SyslogMessages to RFC3164 and RFC5424 messages and back.

title: Id

description: The id of this node

title: Tar File

description: Archive files into tarballs or extract files from tarballs.

title: Allow Empty Directory

description: If the tar file has more than one entry, setting this option to true, allows to get the iterator even if the directory is empty

title: Id

description: The id of this node

title: Max Decompressed Size

description: Set the maximum decompressed size of a tar file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size.

title: Preserve Path Elements

description: If the file name contains path elements, setting this option to true, allows the path to be maintained in the tar file.

title: Using Iterator

description: If the tar file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode.

title: Thrift

description: Serialize and deserialize messages using Apache Thrift binary data format.

title: Content Type Format

description: Defines a content type format in which thrift message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native binary thrift, json or simple json fields representation. The default value is binary.

title: Content Type Header

title: Id

description: The id of this node

title: Instance Class

description: Name of class to use when unmarshalling

title: TidyMarkup

description: Parse (potentially invalid) HTML into valid HTML or DOM.

title: Data Object Type

description: What data type to unmarshal as, can either be org.w3c.dom.Node or java.lang.String. Is by default org.w3c.dom.Node

title: Id

description: The id of this node

title: Omit Xml Declaration

description: When returning a String, do we omit the XML declaration in the top.

title: uniVocity CSV

description: Marshal and unmarshal Java objects from and to CSV (Comma Separated Values) using UniVocity Parsers.

title: As Map

description: Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false

title: Comment

description: The comment symbol. The default value is #

title: Delimiter

description: The delimiter of values

title: Empty Value

description: The String representation of an empty value

title: Header Extraction Enabled

description: Whether or not the header must be read in the first line of the test document The default value is false

title: Headers Disabled

description: Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false

title: Id

description: The id of this node

title: Ignore Leading Whitespaces

description: Whether or not the leading white spaces must be ignored. The default value is true

title: Ignore Trailing Whitespaces

description: Whether or not the trailing white spaces must be ignored. The default value is true

title: Lazy Load

description: Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false

title: Line Separator

description: The line separator of the files The default value is to use the JVM platform line separator

title: Normalized Line Separator

description: The normalized line separator of the files The default value is a new line character.

title: Null Value

description: The string representation of a null value. The default value is null

title: Number Of Records To Read

description: The maximum number of record to read.

title: Quote

description: The quote symbol.

title: Quote All Fields

description: Whether or not all values must be quoted when writing them.

title: Quote Escape

description: The quote escape symbol

title: Skip Empty Lines

description: Whether or not the empty lines must be ignored. The default value is true

title: uniVocity Fixed Length

description: Marshal and unmarshal Java objects from and to fixed length records using UniVocity Parsers.

title: As Map

title: Comment

title: Empty Value

title: Header Extraction Enabled

title: Headers Disabled

title: Id

description: The id of this node

title: Ignore Leading Whitespaces

title: Ignore Trailing Whitespaces

title: Lazy Load

title: Line Separator

title: Normalized Line Separator

title: Null Value

title: Number Of Records To Read

description: The maximum number of record to read.

title: Padding

description: The padding character. The default value is a space

title: Record Ends On Newline

description: Whether or not the record ends on new line. The default value is false

title: Skip Empty Lines

title: Skip Trailing Chars Until Newline

description: Whether or not the trailing characters until new line must be ignored. The default value is false

title: uniVocity Header

description: To configure headers for UniVocity data formats.

title: Length

description: Header length

title: Name

description: Header name

title: uniVocity TSV

description: Marshal and unmarshal Java objects from and to TSV (Tab-Separated Values) records using UniVocity Parsers.

title: As Map

title: Comment

title: Empty Value

title: Escape Char

description: The escape character.

title: Header Extraction Enabled

title: Headers Disabled

title: Id

description: The id of this node

title: Ignore Leading Whitespaces

title: Ignore Trailing Whitespaces

title: Lazy Load

title: Line Separator

title: Normalized Line Separator

title: Null Value

title: Number Of Records To Read

description: The maximum number of record to read.

title: Skip Empty Lines

title: XML Security

description: Encrypt and decrypt XML payloads using Apache Santuario.

title: Add Key Value For Encrypted Key

description: Whether to add the public key used to encrypt the session key as a KeyValue in the EncryptedKey structure or not.

title: Digest Algorithm

description: The digest algorithm to use with the RSA OAEP algorithm. The available choices are: XMLCipher.SHA1 XMLCipher.SHA256 XMLCipher.SHA512 The default value is XMLCipher.SHA1

title: Id

description: The id of this node

title: Key Cipher Algorithm

description: The cipher algorithm to be used for encryption/decryption of the asymmetric key. The available choices are: XMLCipher.RSA_v1dot5 XMLCipher.RSA_OAEP XMLCipher.RSA_OAEP_11 The default value is XMLCipher.RSA_OAEP

title: Key Or Trust Store Parameters Ref

description: Refers to a KeyStore instance to lookup in the registry, which is used for configuration options for creating and loading a KeyStore instance that represents the sender's trustStore or recipient's keyStore.

title: Key Password

description: The password to be used for retrieving the private key from the KeyStore. This key is used for asymmetric decryption.

title: Mgf Algorithm

description: The MGF Algorithm to use with the RSA OAEP algorithm. The available choices are: EncryptionConstants.MGF1_SHA1 EncryptionConstants.MGF1_SHA256 EncryptionConstants.MGF1_SHA512 The default value is EncryptionConstants.MGF1_SHA1

title: Pass Phrase

description: A String used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a Only another 24 Byte key

title: Pass Phrase Byte

description: A byte used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a Only another 24 Byte key

title: Recipient Key Alias

description: The key alias to be used when retrieving the recipient's public or private key from a KeyStore when performing asymmetric key encryption or decryption.

title: Secure Tag

description: The XPath reference to the XML Element selected for encryption/decryption. If no tag is specified, the entire payload is encrypted/decrypted.

title: Secure Tag Contents

description: A boolean value to specify whether the XML Element is to be encrypted or the contents of the XML Element. false = Element Level. true = Element Content Level.

title: Xml Cipher Algorithm

description: The cipher algorithm to be used for encryption/decryption of the XML message content. The available choices are: XMLCipher.TRIPLEDES XMLCipher.AES_128 XMLCipher.AES_128_GCM XMLCipher.AES_192 XMLCipher.AES_192_GCM XMLCipher.AES_256 XMLCipher.AES_256_GCM XMLCipher.SEED_128 XMLCipher.CAMELLIA_128 XMLCipher.CAMELLIA_192 XMLCipher.CAMELLIA_256 The default value is XMLCipher.AES_256_GCM

title: YAML

description: Marshal and unmarshal Java objects to and from YAML.

title: Allow Any Type

description: Allow any class to be un-marshaled

title: Allow Recursive Keys

description: Set whether recursive keys are allowed.

title: Constructor

description: BaseConstructor to construct incoming documents.

title: Dumper Options

description: DumperOptions to configure outgoing objects.

title: Id

description: The id of this node

title: Library

description: Which yaml library to use. By default it is SnakeYAML

title: Max Aliases For Collections

description: Set the maximum amount of aliases allowed for collections.

title: Pretty Flow

description: Force the emitter to produce a pretty YAML document when using the flow style.

title: Representer

description: Representer to emit outgoing objects.

title: Resolver

description: Resolver to detect implicit type

title: Type Filter

description: Set the types SnakeYAML is allowed to un-marshall

title: Unmarshal Type

title: Use Application Context Class Loader

description: Use ApplicationContextClassLoader as custom ClassLoader

title: YAML Type Filter

title: Type

description: Whether to filter by class type or regular expression

title: Value

description: Value of type such as class name or regular expression

title: Zip Deflater

description: Compress and decompress streams using java.util.zip.Deflater and java.util.zip.Inflater.

title: Compression Level

description: To specify a specific compression between 0-9. -1 is default compression, 0 is no compression, and 9 is the best compression.

title: Id

description: The id of this node

title: Zip File

description: Compression and decompress streams using java.util.zip.ZipStream.

title: Allow Empty Directory

description: If the zip file has more than one entry, setting this option to true, allows to get the iterator even if the directory is empty

title: Id

description: The id of this node

title: Max Decompressed Size

description: Set the maximum decompressed size of a zip file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size.

title: Preserve Path Elements

description: If the file name contains path elements, setting this option to true, allows the path to be maintained in the zip file.

title: Using Iterator

description: If the zip file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode.

title: Dead Letter Channel

description: Error handler with dead letter queue.

title: Dead Letter Handle New Exception

description: Whether the dead letter channel should handle (and ignore) any new exception that may been thrown during sending the message to the dead letter endpoint. The default value is true which means any such kind of exception is handled and ignored. Set this to false to let the exception be propagated back on the org.apache.camel.Exchange . This can be used in situations where you use transactions, and want to use Camel's dead letter channel to deal with exceptions during routing, but if the dead letter channel itself fails because of a new exception being thrown, then by setting this to false the new exceptions is propagated back and set on the org.apache.camel.Exchange , which allows the transaction to detect the exception, and rollback.

title: Dead Letter Uri

description: The dead letter endpoint uri for the Dead Letter error handler.

title: Executor Service Ref

description: Sets a reference to a thread pool to be used by the error handler

title: Id

description: The id of this node

title: Level

description: Logging level to use when using the logging error handler type.

title: Log Name

description: Name of the logger to use for the logging error handler

title: Logger Ref

description: References to a logger to use as logger for the error handler

title: On Exception Occurred Ref

title: On Prepare Failure Ref

description: Sets a reference to a processor to prepare the org.apache.camel.Exchange before handled by the failure processor / dead letter channel. This allows for example to enrich the message before sending to a dead letter queue.

title: On Redelivery Ref

title: Redelivery Policy

description: Sets the redelivery settings

title: Redelivery Policy Ref

description: Sets a reference to a RedeliveryPolicy to be used for redelivery settings.

title: Retry While Ref

description: Sets a retry while predicate. Will continue retrying until the predicate evaluates to false.

title: Use Original Body

description: Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off.

title: Use Original Message

description: Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off.

title: Default Error Handler

description: The default error handler.

title: Executor Service Ref

title: Id

description: The id of this node

title: Level

title: Log Name

title: Logger Ref

title: On Exception Occurred Ref

title: On Prepare Failure Ref

title: On Redelivery Ref

title: Redelivery Policy

description: Sets the redelivery settings

title: Redelivery Policy Ref

title: Retry While Ref

title: Use Original Body

title: Use Original Message

title: Jta Transaction Error Handler

description: JTA based transactional error handler (requires camel-jta).

title: Executor Service Ref

title: Id

description: The id of this node

title: Level

title: Log Name

title: Logger Ref

title: On Exception Occurred Ref

title: On Prepare Failure Ref

title: On Redelivery Ref

title: Redelivery Policy

description: Sets the redelivery settings

title: Redelivery Policy Ref

title: Retry While Ref

title: Rollback Logging Level

description: Sets the logging level to use for logging transactional rollback. This option is default WARN.

title: Transacted Policy Ref

description: The transacted policy to use that is configured for either Spring or JTA based transactions. If no policy has been configured then Camel will attempt to auto-discover.

title: Use Original Body

title: Use Original Message

title: No Error Handler

description: To not use an error handler.

title: Id

description: The id of this node

title: Ref Error Handler

description: References to an existing or custom error handler.

title: Id

description: The id of this node

title: Ref

title: Spring Transaction Error Handler

description: Spring based transactional error handler (requires camel-spring).

title: Executor Service Ref

title: Id

description: The id of this node

title: Level

title: Log Name

title: Logger Ref

title: On Exception Occurred Ref

title: On Prepare Failure Ref

title: On Redelivery Ref

title: Redelivery Policy

description: Sets the redelivery settings

title: Redelivery Policy Ref

title: Retry While Ref

title: Rollback Logging Level

title: Transacted Policy Ref

title: Use Original Body

title: Use Original Message

title: CSimple

description: Evaluate a compiled simple expression.

title: Expression

description: The expression value in your chosen language syntax

title: Id

description: Sets the id of this node

title: Result Type

description: Sets the class of the result type (type from output)

title: Trim

description: Whether to trim the value to remove leading and trailing whitespaces and line breaks

title: Constant

description: A fixed value set only once during the route startup.

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: DataSonnet

description: To use DataSonnet scripts for message transformations.

title: Body Media Type

description: The String representation of the message's body MediaType

title: Expression

title: Id

description: Sets the id of this node

title: Output Media Type

description: The String representation of the MediaType to output

title: Result Type

title: Trim

title: ExchangeProperty

description: Gets a property from the Exchange.

title: Expression

title: Id

description: Sets the id of this node

title: Trim

title: Groovy

description: Evaluates a Groovy script.

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: Header

description: Gets a header from the Exchange.

title: Expression

title: Id

description: Sets the id of this node

title: Trim

title: HL7 Terser

description: Get the value of a HL7 message field specified by terse location specification syntax.

title: Expression

title: Header Name

description: Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.

title: Id

description: Sets the id of this node

title: Property Name

description: Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.

title: Result Type

title: Trim

title: JavaScript

description: Evaluates a JavaScript expression.

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: jOOR

description: Evaluates a jOOR (Java compiled once at runtime) expression.

title: Expression

title: Id

description: Sets the id of this node

title: Pre Compile

description: Whether the expression should be pre compiled once during initialization phase. If this is turned off, then the expression is reloaded and compiled on each evaluation.

title: Result Type

title: Single Quotes

description: Whether single quotes can be used as replacement for double quotes. This is convenient when you need to work with strings inside strings.

title: Trim

title: JQ

description: Evaluates a JQ expression against a JSON message body.

title: Expression

title: Header Name

title: Id

description: Sets the id of this node

title: Property Name

title: Result Type

title: Trim

title: JSONPath

description: Evaluates a JSONPath expression against a JSON message body.

title: Allow Easy Predicate

description: Whether to allow using the easy predicate parser to pre-parse predicates.

title: Allow Simple

description: Whether to allow in inlined Simple exceptions in the JSONPath expression

title: Expression

title: Header Name

title: Id

description: Sets the id of this node

title: Option

description: To configure additional options on JSONPath. Multiple values can be separated by comma.

title: Property Name

title: Result Type

title: Suppress Exceptions

description: Whether to suppress exceptions such as PathNotFoundException.

title: Trim

title: Unpack Array

description: Whether to unpack a single element json-array into an object.

title: Write As String

description: Whether to write the output of each row/element as a JSON String value instead of a Map/POJO value.

title: Language

description: Evaluates a custom language.

title: Expression

title: Id

description: Sets the id of this node

title: Language

description: The name of the language to use

title: Trim

title: Bean Method

description: Calls a Java bean method.

title: Bean Type

description: Class name (fully qualified) of the bean to use Will lookup in registry and if there is a single instance of the same type, then the existing bean is used, otherwise a new bean is created (requires a default no-arg constructor).

title: Id

description: Sets the id of this node

title: Method

description: Name of method to call

title: Ref

description: Reference to an existing bean (bean id) to lookup in the registry

title: Result Type

title: Scope

title: Trim

title: MVEL

description: Evaluates a MVEL template.

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: OGNL

description: Evaluates an OGNL expression (Apache Commons OGNL).

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: Python

description: Evaluates a Python expression.

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: Ref

description: Uses an existing expression from the registry.

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: Simple

description: Evaluates a Camel simple expression.

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: SpEL

description: Evaluates a Spring expression (SpEL).

title: Expression

title: Id

description: Sets the id of this node

title: Result Type

title: Trim

title: Tokenize

description: Tokenize text payloads using delimiter patterns.

title: End Token

description: The end token to use as tokenizer if using start/end token pairs. You can use simple language as the token to support dynamic tokens.

title: Group

description: To group N parts together, for example to split big files into chunks of 1000 lines. You can use simple language as the group to support dynamic group sizes.

title: Group Delimiter

description: Sets the delimiter to use when grouping. If this has not been set then token will be used as the delimiter.

title: Header Name

title: Id

description: Sets the id of this node

title: Include Tokens

description: Whether to include the tokens in the parts when using pairs. When including tokens then the endToken property must also be configured (to use pair mode). The default value is false

title: Inherit Namespace Tag Name

description: To inherit namespaces from a root/parent tag name when using XML You can use simple language as the tag name to support dynamic names.

title: Property Name

title: Regex

description: If the token is a regular expression pattern. The default value is false

title: Skip First

description: To skip the very first element

title: Token

description: The (start) token to use as tokenizer, for example you can use the new line token. You can use simple language as the token to support dynamic tokens.

title: Trim

title: Xml

description: Whether the input is XML messages. This option must be set to true if working with XML payloads.

title: XML Tokenize

description: Tokenize XML payloads.

title: Expression

title: Group

description: To group N parts together

title: Header Name

title: Id

description: Sets the id of this node

title: Mode

description: The extraction mode. The available extraction modes are: i - injecting the contextual namespace bindings into the extracted token (default) w - wrapping the extracted token in its ancestor context u - unwrapping the extracted token to its child content t - extracting the text content of the specified element

title: Namespace

description: Injects the XML Namespaces of prefix - uri mappings

title: Property Name

title: Trim

title: XPath

description: Evaluates an XPath expression against an XML payload.

title: Document Type

description: Name of class for document type The default value is org.w3c.dom.Document

title: Expression

title: Factory Ref

description: References to a custom XPathFactory to lookup in the registry

title: Header Name

title: Id

description: Sets the id of this node

title: Log Namespaces

description: Whether to log namespaces which can assist during troubleshooting

title: Namespace

title: Object Model

description: The XPath object model to use

title: Pre Compile

description: Whether to enable pre-compiling the xpath expression during initialization phase. pre-compile is enabled by default. This can be used to turn off, for example in cases the compilation phase is desired at the starting phase, such as if the application is ahead of time compiled (for example with camel-quarkus) which would then load the xpath factory of the built operating system, and not a JVM runtime.

title: Property Name

title: Result Type

description: Sets the class name of the result type (type from output) The default result type is NodeSet

title: Saxon

description: Whether to use Saxon.

title: Thread Safety

description: Whether to enable thread-safety for the returned result of the xpath expression. This applies to when using NODESET as the result type, and the returned set has multiple elements. In this situation there can be thread-safety issues if you process the NODESET concurrently such as from a Camel Splitter EIP in parallel processing mode. This option prevents concurrency issues by doing defensive copies of the nodes. It is recommended to turn this option on if you are using camel-saxon or Saxon in your application. Saxon has thread-safety issues which can be prevented by turning this option on.

title: Trim

title: XQuery

description: Evaluates an XQuery expressions against an XML payload.

title: Configuration Ref

description: Reference to a saxon configuration instance in the registry to use for xquery (requires camel-saxon). This may be needed to add custom functions to a saxon configuration, so these custom functions can be used in xquery expressions.

title: Expression

title: Header Name

title: Id

description: Sets the id of this node

title: Namespace

title: Property Name

title: Result Type

title: Trim

title: Type

title: Custom Load Balancer

description: To use a custom load balancer implementation.

title: Id

description: The id of this node

title: Ref

description: Refers to the custom load balancer to lookup from the registry

title: Failover

description: In case of failures the exchange will be tried on the next endpoint.

title: Exception

description: A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored

title: Id

description: The id of this node

title: Maximum Failover Attempts

description: A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be used whether or not roundRobin is enabled or not.

title: Round Robin

description: Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will continue with the next endpoint in a round robin fashion. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balancing (instead of using the next when starting).

title: Sticky

description: Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the last known good endpoint. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balancing (instead of using the next when starting).

title: Random

description: The destination endpoints are selected by random.

title: Id

description: The id of this node

title: Round Robin

description: The destination endpoints are selected in a round-robin fashion. This is a well known and classic policy, which spreads the load evenly.

title: Id

description: The id of this node

title: Sticky

description: Sticky load balancing using an expression to calculate a correlation key to perform the sticky load balancing.

title: Correlation Expression

description: The correlation expression to use to calculate the correlation key

title: Id

description: The id of this node

title: Topic

description: Topic which sends to all destinations.

title: Id

description: The id of this node

title: Weighted

description: Uses a weighted load distribution ratio for each server with respect to others.

title: Distribution Ratio

description: The distribution ratio is a delimited String consisting on integer weights separated by delimiters for example 2,3,5. The distributionRatio must match the number of endpoints and/or processors specified in the load balancer list.

title: Distribution Ratio Delimiter

description: Delimiter used to specify the distribution ratio. The default value is , (comma)

title: Id

description: The id of this node

title: Round Robin

description: To enable round robin mode. By default the weighted distribution mode is used. The default value is false.

title: Api Key

description: Rest security basic auth definition

title: Description

description: A short description for security scheme.

title: In Cookie

description: To use a cookie as the location of the API key.

title: In Header

description: To use header as the location of the API key.

title: In Query

description: To use query parameter as the location of the API key.

title: Key

description: Key used to refer to this security definition

title: Name

description: The name of the header or query parameter to be used.

title: Basic Auth

description: Rest security basic auth definition

title: Description

title: Key

title: Bearer Token

description: Rest security bearer token authentication definition

title: Description

title: Format

description: A hint to the client to identify how the bearer token is formatted.

title: Key

title: Delete

description: Rest DELETE command

title: Api Docs

description: Whether to include or exclude this rest operation in API documentation. The default value is true.

title: Binding Mode

description: Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off

title: Client Request Validation

description: Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.

title: Consumes

description: To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level

title: Deprecated

description: Marks this rest operation as deprecated in OpenApi documentation.

title: Id

description: Sets the id of this node

title: Disabled

description: Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime.

title: Id

description: Sets the id of this node

title: Out Type

description: Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.

title: Path

description: The path mapping URIs of this REST operation such as /{id}.

title: Produces

description: To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level

title: Route Id

description: Sets the id of the route

title: Skip Binding On Error Code

description: Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level

title: To

description: The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.

title: Type

description: Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.

title: Get

description: Rest GET command

title: Api Docs

title: Binding Mode

title: Client Request Validation

title: Consumes

title: Deprecated

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Out Type

title: Path

title: Produces

title: Route Id

description: Sets the id of the route

title: Skip Binding On Error Code

title: To

title: Type

title: Head

description: Rest HEAD command

title: Api Docs

title: Binding Mode

title: Client Request Validation

title: Consumes

title: Deprecated

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Out Type

title: Path

title: Produces

title: Route Id

description: Sets the id of the route

title: Skip Binding On Error Code

title: To

title: Type

title: Mutual TLS

description: Rest security mutual TLS authentication definition

title: Description

title: Key

title: Oauth2

description: Rest security OAuth2 definition

title: Authorization Url

description: The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Required for implicit and access code flows

title: Description

title: Flow

description: The flow used by the OAuth2 security scheme. Valid values are implicit, password, application or accessCode.

enum: implicit password application clientCredentials accessCode authorizationCode

title: Key

title: Refresh Url

description: The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.

title: Scopes

description: The available scopes for an OAuth2 security scheme

title: Token Url

description: The token URL to be used for this flow. This SHOULD be in the form of a URL. Required for password, application, and access code flows.

title: Open Id Connect

description: Rest security OpenID Connect definition

title: Description

title: Key

title: Url

description: OpenId Connect URL to discover OAuth2 configuration values.

title: Param

description: To specify the rest operation parameters.

title: Allowable Values

description: Sets the parameter list of allowable values (enum).

title: Array Type

description: Sets the parameter array type. Required if data type is array. Describes the type of items in the array.

title: Collection Format

description: Sets the parameter collection format.

title: Data Format

description: Sets the parameter data format.

title: Data Type

description: Sets the parameter data type.

title: Default Value

description: Sets the parameter default value.

title: Description

description: Sets the parameter description.

title: Examples

description: Sets the parameter examples.

title: Name

description: Sets the parameter name.

title: Required

description: Sets the parameter required flag.

title: Type

description: Sets the parameter type.

title: Patch

description: Rest PATCH command

title: Api Docs

title: Binding Mode

title: Client Request Validation

title: Consumes

title: Deprecated

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Out Type

title: Path

title: Produces

title: Route Id

description: Sets the id of the route

title: Skip Binding On Error Code

title: To

title: Type

title: Post

description: Rest POST command

title: Api Docs

title: Binding Mode

title: Client Request Validation

title: Consumes

title: Deprecated

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Out Type

title: Path

title: Produces

title: Route Id

description: Sets the id of the route

title: Skip Binding On Error Code

title: To

title: Type

title: Put

description: Rest PUT command

title: Api Docs

title: Binding Mode

title: Client Request Validation

title: Consumes

title: Deprecated

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Out Type

title: Path

title: Produces

title: Route Id

description: Sets the id of the route

title: Skip Binding On Error Code

title: To

title: Type

title: Response Header

description: To specify the rest operation response headers.

title: Allowable Values

description: Sets the parameter list of allowable values.

title: Array Type

title: Collection Format

description: Sets the parameter collection format.

title: Data Format

description: Sets the parameter data format.

title: Data Type

description: Sets the header data type.

title: Description

description: Description of the parameter.

title: Example

description: Sets the example

title: Name

description: Name of the parameter. This option is mandatory.

title: Response Message

description: To specify the rest operation response messages.

title: Code

description: The response code such as a HTTP status code

title: Examples

description: Examples of response messages

title: Header

description: Adds a response header

title: Message

description: The response message (description)

title: Response Model

description: The response model

title: Rest Binding

description: To configure rest binding

title: Binding Mode

description: Sets the binding mode to use. The default value is off

title: Client Request Validation

title: Component

description: Sets the component name that this definition will apply to

title: Consumes

description: To define the content type what the REST service consumes (accept as input), such as application/xml or application/json

title: Id

description: Sets the id of this node

title: Id

description: Sets the id of this node

title: Out Type

description: Sets the class name to use for binding from POJO to output for the outgoing data The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.

title: Produces

description: To define the content type what the REST service produces (uses for output), such as application/xml or application/json

title: Skip Binding On Error Code

description: Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do.

title: Type

description: Sets the class name to use for binding from input to POJO for the incoming data The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.

title: Rest Configuration

description: To configure rest

title: Api Component

description: The name of the Camel component to use as the REST API. If no API Component has been explicit configured, then Camel will lookup if there is a Camel component responsible for servicing and generating the REST API documentation, or if a org.apache.camel.spi.RestApiProcessorFactory is registered in the registry. If either one is found, then that is being used.

title: Api Context Path

description: Sets a leading API context-path the REST API services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path.

title: Api Context Route Id

description: Sets the route id to use for the route that services the REST API. The route will by default use an auto assigned route id.

title: Api Host

description: To use a specific hostname for the API documentation (such as swagger or openapi) This can be used to override the generated host with this configured hostname

title: Api Property

description: Allows to configure as many additional properties for the api documentation. For example set property api.title to my cool stuff

title: Api Vendor Extension

description: Whether vendor extension is enabled in the Rest APIs. If enabled then Camel will include additional information as vendor extension (eg keys starting with x-) such as route ids, class names etc. Not all 3rd party API gateways and tools supports vendor-extensions when importing your API docs.

title: Binding Mode

title: Client Request Validation

title: Component

description: The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used.

enum: platform-http servlet jetty undertow netty-http coap

title: Component Property

description: Allows to configure as many additional properties for the rest component in use.

title: Consumer Property

description: Allows to configure as many additional properties for the rest consumer in use.

title: Context Path

description: Sets a leading context-path the REST services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path. Or for components such as camel-jetty or camel-netty-http that includes a HTTP server.

title: Cors Headers

description: Allows to configure custom CORS headers.

title: Data Format Property

description: Allows to configure as many additional properties for the data formats in use. For example set property prettyPrint to true to have json outputted in pretty mode. The properties can be prefixed to denote the option is only for either JSON or XML and for either the IN or the OUT. The prefixes are: json.in. json.out. xml.in. xml.out. For example a key with value xml.out.mustBeJAXBElement is only for the XML data format for the outgoing. A key without a prefix is a common key for all situations.

title: Endpoint Property

description: Allows to configure as many additional properties for the rest endpoint in use.

title: Host

description: The hostname to use for exposing the REST service.

title: Host Name Resolver

description: If no hostname has been explicit configured, then this resolver is used to compute the hostname the REST service will be using.

title: Inline Routes

description: Inline routes in rest-dsl which are linked using direct endpoints. By default, each service in Rest DSL is an individual route, meaning that you would have at least two routes per service (rest-dsl, and the route linked from rest-dsl). Enabling this allows Camel to optimize and inline this as a single route, however this requires to use direct endpoints, which must be unique per service. This option is default false.

title: Json Data Format

description: Name of specific json data format to use. By default jackson will be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.

title: Port

description: The port number to use for exposing the REST service. Notice if you use servlet component then the port number configured here does not apply, as the port number in use is the actual port number the servlet component is using. eg if using Apache Tomcat its the tomcat http port, if using Apache Karaf its the HTTP service in Karaf that uses port 8181 by default etc. Though in those situations setting the port number here, allows tooling and JMX to know the port number, so its recommended to set the port number to the number that the servlet engine uses.

title: Producer Api Doc

description: Sets the location of the api document the REST producer will use to validate the REST uri and query parameters are valid accordingly to the api document. The location of the api document is loaded from classpath by default, but you can use file: or http: to refer to resources to load from file or http url.

title: Producer Component

description: Sets the name of the Camel component to use as the REST producer

title: Scheme

description: The scheme to use for exposing the REST service. Usually http or https is supported. The default value is http

title: Skip Binding On Error Code

title: Use XForward Headers

description: Whether to use X-Forward headers for Host and related setting. The default value is true.

title: Xml Data Format

description: Name of specific XML data format to use. By default jaxb will be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.

title: Rest

description: Defines a rest service using the rest-dsl

title: Api Docs

description: Whether to include or exclude this rest operation in API documentation. This option will override what may be configured on a parent level. The default value is true.

title: Binding Mode

description: Sets the binding mode to use. This option will override what may be configured on a parent level The default value is auto

title: Client Request Validation

title: Consumes

title: Id

description: Sets the id of this node

title: Disabled

title: Id

description: Sets the id of this node

title: Path

description: Path of the rest service, such as /foo

title: Produces

title: Security Definitions

description: Sets the security definitions such as Basic, OAuth2 etc.

title: Security Requirements

description: Sets the security requirement(s) for all endpoints.

title: Skip Binding On Error Code

title: Tag

description: To configure a special tag for the operations within this rest definition.

title: Rest Property

description: A key value pair

title: Key

description: Property key

title: Value

description: Property value

title: Rest Security Definitions

description: To configure rest security definitions.

title: Rests

description: A series of rest services defined using the rest-dsl

title: Id

description: Sets the id of this node

title: Id

description: Sets the id of this node

title: Rest Security

description: Rest security definition

title: Key

title: Scopes

description: The scopes to allow (separate multiple scopes by comma)

title: Transformations

description: To configure transformers.

title: Validations

description: To configure validators.