Uses of Interface
org.apache.camel.Exchange
Package
Description
The core Camel API.
Camel cloud
Service Provider Interfaces used by the Camel runtime which are plugin strategies.
-
Uses of Exchange in org.apache.camel
Modifier and TypeInterfaceDescriptioninterface
PooledExchange
which contains the methods and APIs that are not intended for Camel end users but used internally by Camel for optimizing memory footprint by reusing exchanges created byConsumer
s viaExchangeFactory
.Modifier and TypeMethodDescriptionAggregates an old and new exchange together to create a single combined exchangedefault Exchange
Aggregates an old and new exchange together to create a single combined exchange.Exchange.copy()
Creates a copy of the current message exchange so that it can be forwarded to another destinationConsumer.createExchange
(boolean autoRelease) Creates anExchange
that was consumed.Endpoint.createExchange()
Create a new exchange for communicating with this endpoint.Endpoint.createExchange
(ExchangePattern pattern) Create a new exchange for communicating with this endpoint with the specifiedExchangePattern
such as whether its going to be anExchangePattern.InOnly
orExchangePattern.InOut
exchangeCamelExchangeException.getExchange()
Returns the exchange which caused the exceptionExpectedBodyTypeException.getExchange()
ExpressionEvaluationException.getExchange()
Message.getExchange()
Returns the exchange this message is related toRuntimeExchangeException.getExchange()
Returns the exchange which caused the exceptionReceives from the endpoint, waiting until there is a responseReceives from the endpoint, waiting until there is a response or the timeout occursReceives from the endpoint, waiting until there is a response.Receives from the endpoint, waiting until there is a response or the timeout occursPollingConsumer.receive()
Waits until a message is available and then returns it.PollingConsumer.receive
(long timeout) Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available.ConsumerTemplate.receiveNoWait
(String endpointUri) Receives from the endpoint, not waiting for a response if non exists.ConsumerTemplate.receiveNoWait
(Endpoint endpoint) Receives from the endpoint, not waiting for a response if non exists.PollingConsumer.receiveNoWait()
Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet.Sends an exchange to an endpoint using a supplied processor Uses anExchangePattern.InOut
message exchange pattern.Sends an exchange to an endpoint using a supplied processor Uses anExchangePattern.InOut
message exchange pattern.FluentProducerTemplate.send()
Send to an endpoint (InOnly)Sends the exchange to the given endpoint
ProducerTemplate.send
(String endpointUri, ExchangePattern pattern, Processor processor) Sends an exchange to an endpoint using a supplied processor
Sends an exchange to an endpoint using a supplied processor
Sends the exchange to the given endpoint
ProducerTemplate.send
(Endpoint endpoint, ExchangePattern pattern, Processor processor) Sends an exchange to an endpoint using a supplied processor
ProducerTemplate.send
(Endpoint endpoint, ExchangePattern pattern, Processor processor, Processor resultProcessor) Sends an exchange to an endpoint using a supplied processor
Sends an exchange to an endpoint using a supplied processor
Sends the exchange to the default endpoint
Notice: that if the processing of the exchange failed with an Exception it is not thrown from this method, but you can access it from the returned exchange usinggetException()
.Sends an exchange to the default endpoint using a supplied processor
Notice: that if the processing of the exchange failed with an Exception it is not thrown from this method, but you can access it from the returned exchange usinggetException()
.Modifier and TypeMethodDescriptionFluentProducerTemplate.asyncSend()
Sends asynchronously to the given endpoint (InOnly).Sends an asynchronous exchange to the given endpoint.Sends an asynchronous exchange to the given endpoint.Sends an asynchronous exchange to the given endpoint.Sends an asynchronous exchange to the given endpoint.AsyncProcessor.processAsync
(Exchange exchange) Modifier and TypeMethodDescriptionAggregates an old and new exchange together to create a single combined exchangedefault Exchange
Aggregates an old and new exchange together to create a single combined exchange.Sends an asynchronous exchange to the given endpoint.Sends an asynchronous exchange to the given endpoint.void
Endpoint.configureExchange
(Exchange exchange) Configures a newly createdExchange
.<T> T
Converts the value to the specified type in the context of an exchangeCreate a copy of the stream.void
ExchangeExtension.copyInternalProperties
(Exchange target) To copy the internal properties from this exchange to the target exchangestatic String
CamelExchangeException.createExceptionMessage
(String message, Exchange exchange, Throwable cause) Creates an exception message with the provided details.protected static String
RuntimeExchangeException.createMessage
(String message, Exchange exchange) default AsyncCallback
Consumer.defaultConsumerCallback
(Exchange exchange, boolean autoRelease) The default callback to use with the consumer when calling the processor using asynchronous routing.void
<T> T
Returns the value of the expression on the given exchangevoid
ExchangeExtension.handoverCompletions
(Exchange target) Handover all the on completions from this exchange to the target exchange.protected static String
<T> T
TypeConverter.mandatoryConvertTo
(Class<T> type, Exchange exchange, Object value) Converts the value to the specified type in the context of an exchangeboolean
Evaluates the predicate on the message exchange and returns true if this exchange matches the predicateBinaryPredicate.matchesReturningFailureMessage
(Exchange exchange) Evaluates the predicate on the message exchange and returns null if this exchange matches the predicate.default void
AggregationStrategy.onCompletion
(Exchange exchange) The aggregatedExchange
has completed Important: This method must not throw any exceptions.default void
AggregationStrategy.onCompletion
(Exchange exchange, Exchange inputExchange) The aggregatedExchange
has completed Important: This method must not throw any exceptions.void
default void
AggregationStrategy.onOptimisticLockFailure
(Exchange oldExchange, Exchange newExchange) Callback when the aggregatedExchange
fails to add in theOptimisticLockingAggregationRepository
because of anOptimisticLockingAggregationRepository.OptimisticLockingException
.default boolean
AggregationStrategy.preComplete
(Exchange oldExchange, Exchange newExchange) Determines if the aggregation should complete the current group, and start a new group, or the aggregation should continue using the current group.boolean
AsyncProcessor.process
(Exchange exchange, AsyncCallback callback) Processes the message exchange.void
Processes the message exchangeAsyncProcessor.processAsync
(Exchange exchange) protected static String
protected static String
protected static String
void
Consumer.releaseExchange
(Exchange exchange, boolean autoRelease) Releases theExchange
when its completed processing and no longer needed.Sends the exchange to the given endpoint
Sends the exchange to the given endpoint
Sends the exchange to the default endpoint
Notice: that if the processing of the exchange failed with an Exception it is not thrown from this method, but you can access it from the returned exchange usinggetException()
.default void
A timeout occurred.<T> T
TypeConverter.tryConvertTo
(Class<T> type, Exchange exchange, Object value) Tries to convert the value to the specified type in the context of an exchange, returning null if not possible to convert.FluentProducerTemplate.withExchange
(Exchange exchange) Set the exchange to use for send.static CamelExecutionException
CamelExecutionException.wrapCamelExecutionException
(Exchange exchange, Throwable e) Wraps the caused exception in aCamelExecutionException
if its not already such an exception.Modifier and TypeMethodDescriptionFluentProducerTemplate.withExchange
(Supplier<Exchange> exchangeSupplier) Set the exchangeSupplier which will be invoke to get the exchange to be used for send.ModifierConstructorDescriptionCamelAuthorizationException
(String message, Exchange exchange) CamelAuthorizationException
(String message, Exchange exchange, Throwable cause) CamelExchangeException
(String message, Exchange exchange) CamelExchangeException
(String message, Exchange exchange, Throwable cause) CamelExecutionException
(String message, Exchange exchange) CamelExecutionException
(String message, Exchange exchange, Throwable cause) CamelUnitOfWorkException
(Exchange exchange, List<Exception> causes) ExchangeTimedOutException
(Exchange exchange, long timeout) ExchangeTimedOutException
(Exchange exchange, long timeout, String message) ExpectedBodyTypeException
(Exchange exchange, Class<?> expectedBodyType) ExpressionEvaluationException
(Expression expression, String message, Exchange exchange, Throwable cause) ExpressionEvaluationException
(Expression expression, Exchange exchange, Throwable cause) InvalidPayloadException
(Exchange exchange, Class<?> type) InvalidPayloadException
(Exchange exchange, Class<?> type, Message message) InvalidPayloadException
(Exchange exchange, Class<?> type, Message message, Throwable cause) InvalidPayloadRuntimeException
(Exchange exchange, Class<?> type) InvalidPayloadRuntimeException
(Exchange exchange, Class<?> type, Throwable cause) InvalidPayloadRuntimeException
(Exchange exchange, Class<?> type, Message message) InvalidPayloadRuntimeException
(Exchange exchange, Class<?> type, Message message, Throwable cause) NoSuchHeaderException
(Exchange exchange, String headerName, Class<?> type) NoSuchHeaderOrPropertyException
(Exchange exchange, String headerName, String propertyName, Class<?> type) NoSuchPropertyException
(Exchange exchange, String propertyName, Class<?> type) RollbackExchangeException
(String message, Exchange exchange) RollbackExchangeException
(String message, Exchange exchange, Throwable cause) RollbackExchangeException
(Exchange exchange) RollbackExchangeException
(Exchange exchange, Throwable cause) RuntimeExchangeException
(String message, Exchange exchange) RuntimeExchangeException
(String message, Exchange exchange, Throwable cause) ValidationException
(String message, Exchange exchange, Throwable cause) ValidationException
(Exchange exchange, String message) -
Uses of Exchange in org.apache.camel.cloud
Modifier and TypeMethodDescriptionServiceFilter.apply
(Exchange exchange, List<ServiceDefinition> services) Chooses service candidates to use<T> T
ServiceLoadBalancer.process
(Exchange exchange, String serviceName, ServiceLoadBalancerFunction<T> function) -
Uses of Exchange in org.apache.camel.spi
Modifier and TypeMethodDescriptionAggregationRepository.add
(CamelContext camelContext, String key, Exchange exchange) Add the givenExchange
under the correlation key.OptimisticLockingAggregationRepository.add
(CamelContext camelContext, String key, Exchange oldExchange, Exchange newExchange) Add the givenExchange
under the correlation key.ExchangeFactory.create
(boolean autoRelease) Gets a newExchange
Gets a newExchange
ProcessorExchangeFactory.create
(Endpoint fromEndpoint, ExchangePattern exchangePattern) Gets a newExchange
ProcessorExchangeFactory.createCopy
(Exchange exchange) Gets a copy of the givenExchange
ProcessorExchangeFactory.createCorrelatedCopy
(Exchange exchange, boolean handover) Gets a copy of the givenExchange
and the copy is correlated to the sourceAggregationRepository.get
(CamelContext camelContext, String key) Gets the given exchange with the correlation keyGets the exchange from the repository.ClaimCheckRepository.getAndRemove
(String key) Gets and removes the exchange from the repository.AsyncProcessorAwaitManager.AwaitThread.getExchange()
The exchange being processed by the other thread.CamelEvent.ExchangeEvent.getExchange()
InflightRepository.InflightExchange.getExchange()
The exchange being inflightClaimCheckRepository.pop()
Pops the repository and returns the latest.Waits until a message is available and then returns it.Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available.ConsumerCache.receiveNoWait
(Endpoint endpoint) Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet.RecoverableAggregationRepository.recover
(CamelContext camelContext, String exchangeId) Recovers the exchange with the given exchange idSends the exchange to the given endpoint.Modifier and TypeMethodDescriptionProducerCache.asyncSendExchange
(Endpoint endpoint, ExchangePattern pattern, Processor processor, Processor resultProcessor, Exchange exchange, CompletableFuture<Exchange> future) Asynchronously sends an exchange to an endpoint using a suppliedProcessor
to populate the exchangeBrowsableEndpoint.getExchanges()
Return the exchanges available on this endpointModifier and TypeMethodDescriptionAggregationRepository.add
(CamelContext camelContext, String key, Exchange exchange) Add the givenExchange
under the correlation key.boolean
Adds the exchange to the repository.default boolean
Adds the key to the repository.void
Adds the exchange to the inflight registry to the total countervoid
Adds the exchange to the inflight registry associated to the given routeOptimisticLockingAggregationRepository.add
(CamelContext camelContext, String key, Exchange oldExchange, Exchange newExchange) Add the givenExchange
under the correlation key.void
Callback executed after processing a step in the route.void
void
Breakpoint.afterProcess
(Exchange exchange, Processor processor, NamedNode definition, long timeTaken) Callback invoked when the breakpoint was hit and theExchange
has been processed (after).boolean
Debugger.afterProcess
(Exchange exchange, Processor processor, NamedNode definition, long timeTaken) Callback invoked when anExchange
has been processed which allows implementators to notify breakpoints.void
UnitOfWork.afterProcess
(Processor processor, Exchange exchange, AsyncCallback callback, boolean doneSync) Strategy for work to be executed after the processingvoid
UnitOfWork.afterRoute
(Exchange exchange, Route route) Invoked when this unit of work is done being routed by the given route.boolean
HeaderFilterStrategy.applyFilterToCamelHeaders
(String headerName, Object headerValue, Exchange exchange) Applies filtering logic to Camel Message header that is going to be copied to target message such as CXF and JMS message.boolean
HeaderFilterStrategy.applyFilterToExternalHeaders
(String headerName, Object headerValue, Exchange exchange) Applies filtering logic to an external message header such as CXF and JMS message that is going to be copied to Camel message header.ProducerCache.asyncSendExchange
(Endpoint endpoint, ExchangePattern pattern, Processor processor, Processor resultProcessor, Exchange exchange, CompletableFuture<Exchange> future) Asynchronously sends an exchange to an endpoint using a suppliedProcessor
to populate the exchangeCallback executed before processing a step in the route.void
SynchronizationVetoable.beforeHandover
(Exchange target) A method to perform optional housekeeping when a Synchronization is being handed over.void
Breakpoint.beforeProcess
(Exchange exchange, Processor processor, NamedNode definition) Callback invoked when the breakpoint was hit and theExchange
is about to be processed (before).boolean
Debugger.beforeProcess
(Exchange exchange, Processor processor, NamedNode definition) Callback invoked when anExchange
is about to be processed which allows implementators to notify breakpoints.UnitOfWork.beforeProcess
(Processor processor, Exchange exchange, AsyncCallback callback) Strategy for work to be executed before processing.void
UnitOfWork.beforeRoute
(Exchange exchange, Route route) Invoked when this unit of work is about to be routed by the given route.Caches the body aas aStreamCache
.default boolean
Confirms the key, after the exchange has been processed successfully.default boolean
Returns true if this repository contains the specified element.<T> T
Converts the value to the specified type in the context of an exchangedefault <T> T
EventFactory.createCamelExchangeAsyncProcessingStartedEvent
(Exchange exchange) Creates anCamelEvent
when anExchange
asynchronous processing has been started.UnitOfWork.createChildUnitOfWork
(Exchange childExchange) Create a child unit of work, which is associated to this unit of work as its parent.ProcessorExchangeFactory.createCopy
(Exchange exchange) Gets a copy of the givenExchange
ProcessorExchangeFactory.createCorrelatedCopy
(Exchange exchange, boolean handover) Gets a copy of the givenExchange
and the copy is correlated to the sourceEventFactory.createExchangeCompletedEvent
(Exchange exchange) Creates anCamelEvent
when anExchange
has been completed successfullyEventFactory.createExchangeCreatedEvent
(Exchange exchange) Creates anCamelEvent
when anExchange
has been createdEventFactory.createExchangeFailedEvent
(Exchange exchange) Creates anCamelEvent
when anExchange
has failedEventFactory.createExchangeFailureHandledEvent
(Exchange exchange, Processor failureHandler, boolean deadLetterChannel, String deadLetterUri) Creates anCamelEvent
when anExchange
has failed but was handled by the Camel error handlers such as an dead letter channel, or a doTry ..EventFactory.createExchangeFailureHandlingEvent
(Exchange exchange, Processor failureHandler, boolean deadLetterChannel, String deadLetterUri) Creates anCamelEvent
when anExchange
has failed but is being handled by the Camel error handlers such as an dead letter channel, or a doTry ..EventFactory.createExchangeRedeliveryEvent
(Exchange exchange, int attempt) Creates anCamelEvent
when anExchange
is about to be redeliveredEventFactory.createExchangeSendingEvent
(Exchange exchange, Endpoint endpoint) Creates anCamelEvent
when anExchange
is about to be sent to the endpoint (eg before).EventFactory.createExchangeSentEvent
(Exchange exchange, Endpoint endpoint, long timeTaken) Creates anCamelEvent
when anExchange
has completely been sent to the endpoint (eg after).SendDynamicAware.createPostProcessor
(Exchange exchange, SendDynamicAware.DynamicAwareEntry entry) Creates an optional postProcessor
that will be executed afterwards when the message has been sent dynamic.SendDynamicAware.createPreProcessor
(Exchange exchange, SendDynamicAware.DynamicAwareEntry entry) EventFactory.createStepCompletedEvent
(Exchange exchange, String stepId) Creates anCamelEvent
when a step has been completed successfullyEventFactory.createStepFailedEvent
(Exchange exchange, String stepId) Creates anCamelEvent
when a step has failedEventFactory.createStepStartedEvent
(Exchange exchange, String stepId) Creates anCamelEvent
when a step has been startedUnitOfWorkFactory.createUnitOfWork
(Exchange exchange) Creates a newUnitOfWork
boolean
ProducerCache.AsyncProducerCallback.doInAsyncProducer
(AsyncProducer asyncProducer, Exchange exchange, AsyncCallback callback) Performs operation on the given producer to send the given exchange.boolean
ProducerCache.doInAsyncProducer
(Endpoint endpoint, Exchange exchange, AsyncCallback callback, ProducerCache.AsyncProducerCallback producerCallback) Sends an exchange to an endpoint using a supplied callback supporting the asynchronous routing engine.void
Invoked when this unit of work has been completed, whether it has failed or completedGenerates a string representation of the exchangevoid
ExceptionHandler.handleException
(String message, Exchange exchange, Throwable exception) Handles the given exceptionvoid
UnitOfWork.handoverSynchronization
(Exchange target) Handover all the registered synchronizations to the targetExchange
.void
UnitOfWork.handoverSynchronization
(Exchange target, Predicate<Synchronization> filter) Handover all the registered synchronizations to the targetExchange
.void
To interrupt an exchange which may seem as stuck, to force the exchange to continue, allowing any blocking thread to be released.InvokeOnHeaderStrategy.invoke
(Object target, String key, Exchange exchange, AsyncCallback callback) Invoke the method based on the header keydefault <T> T
BulkTypeConverters.mandatoryConvertTo
(Class<?> from, Class<T> to, Exchange exchange, Object value) Converts the value to the specified type in the context of an exchangedefault <T> T
BulkTypeConverters.mandatoryConvertTo
(Class<T> type, Exchange exchange, Object value) void
DataFormat.marshal
(Exchange exchange, Object graph, OutputStream stream) Marshals the object to the given Stream.boolean
Condition.matchEvent
(Exchange exchange, CamelEvent.ExchangeEvent event) Does the condition matchboolean
Condition.matchProcess
(Exchange exchange, Processor processor, NamedNode definition) Does the condition matchMessageHistoryFactory.newMessageHistory
(String routeId, NamedNode node, long timestamp, Exchange exchange) Creates a newMessageHistory
PredicateExceptionFactory.newPredicateException
(Exchange exchange, Predicate predicate, String nodeId) Allows to return a specific exception for the given predicate in case it failedvoid
NotifyBuilderMatcher.notifyBuilderOnExchange
(Exchange exchange) When an exchange was receivedvoid
SynchronizationRouteAware.onAfterRoute
(Route route, Exchange exchange) Invoked after theExchange
has been routed by the given route.void
SynchronizationRouteAware.onBeforeRoute
(Route route, Exchange exchange) Invoked before theExchange
is being routed by the given route.void
Synchronization.onComplete
(Exchange exchange) Called when the processing of the message exchange is completevoid
Breakpoint.onEvent
(Exchange exchange, CamelEvent.ExchangeEvent event, NamedNode definition) boolean
Debugger.onEvent
(Exchange exchange, CamelEvent.ExchangeEvent event) Callback invoked when anExchange
is being processed which allows implementators to notify breakpoints.void
RoutePolicy.onExchangeBegin
(Route route, Exchange exchange) void
RoutePolicy.onExchangeDone
(Route route, Exchange exchange) void
Called when the processing of the message exchange has failed for some reason.LogListener.onLog
(Exchange exchange, CamelLogger camelLogger, String message) Invoked right before Log component or Log EIP logs.boolean
Prepares this unit of work with the given inputExchange
Prepares for using optimised dynamic to by parsing the uri and returning an entry of details that are used for creating the pre and post processors, and the static uri.void
AsyncProcessorAwaitManager.process
(AsyncProcessor processor, Exchange exchange) Process the given exchange synchronously.default void
boolean
SharedInternalProcessor.process
(Exchange exchange, AsyncCallback originalCallback, AsyncProcessor processor, Processor resultProcessor) Asynchronous APIvoid
SharedInternalProcessor.process
(Exchange exchange, AsyncProcessor processor, Processor resultProcessor) Synchronous APIvoid
Pushes the exchange on top of the repository.default boolean
Releases the exchange back into the poolboolean
Releases the exchange back into the poolvoid
AggregationRepository.remove
(CamelContext camelContext, String key, Exchange exchange) Removes the exchange with the given correlation key, which should happen when anExchange
is completeddefault boolean
Removes the key from the repository.void
Removes the exchange from the inflight registry to the total countervoid
Removes the exchange from the inflight registry removing association to the given routevoid
OptimisticLockingAggregationRepository.remove
(CamelContext camelContext, String key, Exchange exchange) Removes the given Exchange when both the supplied key and Exchange are present in the repository.SendDynamicAware.resolveStaticUri
(Exchange exchange, SendDynamicAware.DynamicAwareEntry entry) Sends the exchange to the given endpoint.void
Tracer.traceAfterNode
(NamedNode node, Exchange exchange) Trace after the given nodevoid
Tracer.traceAfterRoute
(NamedRoute route, Exchange exchange) Trace after the route (eg output from route)void
Tracer.traceBeforeNode
(NamedNode node, Exchange exchange) Trace before the given nodevoid
Tracer.traceBeforeRoute
(NamedRoute route, Exchange exchange) Trace before the route (eg input to route)default <T> T
BulkTypeConverters.tryConvertTo
(Class<?> from, Class<T> to, Exchange exchange, Object value) Tries to convert the value to the specified type, returning null if not possible to convert.default <T> T
BulkTypeConverters.tryConvertTo
(Class<T> type, Exchange exchange, Object value) DataFormat.unmarshal
(Exchange exchange, InputStream stream) Unmarshals the given stream into an object.Modifier and TypeMethodDescriptionProducerCache.asyncSendExchange
(Endpoint endpoint, ExchangePattern pattern, Processor processor, Processor resultProcessor, Exchange exchange, CompletableFuture<Exchange> future) Asynchronously sends an exchange to an endpoint using a suppliedProcessor
to populate the exchange