001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.camel; 018 019import java.util.Date; 020import java.util.List; 021import java.util.Map; 022 023import org.apache.camel.spi.Synchronization; 024import org.apache.camel.spi.UnitOfWork; 025 026/** 027 * An Exchange is the message container holding the information during the entire routing of 028 * a {@link Message} received by a {@link Consumer}. 029 * <p/> 030 * During processing down the {@link Processor} chain, the {@link Exchange} provides access to the 031 * current (not the original) request and response {@link Message} messages. The {@link Exchange} 032 * also holds meta-data during its entire lifetime stored as properties accessible using the 033 * various {@link #getProperty(String)} methods. The {@link #setProperty(String, Object)} is 034 * used to store a property. For example you can use this to store security, SLA related 035 * data or any other information deemed useful throughout processing. If an {@link Exchange} 036 * failed during routing the {@link Exception} that caused the failure is stored and accessible 037 * via the {@link #getException()} method. 038 * <p/> 039 * An Exchange is created when a {@link Consumer} receives a request. A new {@link Message} is 040 * created, the request is set as the body of the {@link Message} and depending on the {@link Consumer} 041 * other {@link Endpoint} and protocol related information is added as headers on the {@link Message}. 042 * Then an Exchange is created and the newly created {@link Message} is set as the in on the Exchange. 043 * Therefore an Exchange starts its life in a {@link Consumer}. The Exchange is then sent down the 044 * {@link Route} for processing along a {@link Processor} chain. The {@link Processor} as the name 045 * suggests is what processes the {@link Message} in the Exchange and Camel, in addition to 046 * providing out-of-the-box a large number of useful processors, it also allows you to create your own. 047 * The rule Camel uses is to take the out {@link Message} produced by the previous {@link Processor} 048 * and set it as the in for the next {@link Processor}. If the previous {@link Processor} did not 049 * produce an out, then the in of the previous {@link Processor} is sent as the next in. At the 050 * end of the processing chain, depending on the {@link ExchangePattern Message Exchange Pattern} (or MEP) 051 * the last out (or in of no out available) is sent by the {@link Consumer} back to the original caller. 052 * <p/> 053 * Camel, in addition to providing out-of-the-box a large number of useful processors, it also allows 054 * you to implement and use your own. When the Exchange is passed to a {@link Processor}, it always 055 * contains an in {@link Message} and no out {@link Message}. The {@link Processor} <b>may</b> produce 056 * an out, depending on the nature of the {@link Processor}. The in {@link Message} can be accessed 057 * using the {@link #getIn()} method. Since the out message is null when entering the {@link Processor}, 058 * the {@link #getOut()} method is actually a convenient factory method that will lazily instantiate a 059 * {@link org.apache.camel.support.DefaultMessage} which you could populate. As an alternative you could 060 * also instantiate your specialized {@link Message} and set it on the exchange using the 061 * {@link #setOut(org.apache.camel.Message)} method. Please note that a {@link Message} contains not only 062 * the body but also headers and attachments. If you are creating a new {@link Message} the headers and 063 * attachments of the in {@link Message} are not automatically copied to the out by Camel and you'll have 064 * to set the headers and attachments you need yourself. If your {@link Processor} is not producing a 065 * different {@link Message} but only needs to slightly modify the in, you can simply update the in 066 * {@link Message} returned by {@link #getIn()}. 067 * <p/> 068 * See this <a href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html">FAQ entry</a> 069 * for more details. 070 */ 071public interface Exchange { 072 073 String AUTHENTICATION = "CamelAuthentication"; 074 String AUTHENTICATION_FAILURE_POLICY_ID = "CamelAuthenticationFailurePolicyId"; 075 @Deprecated 076 String ACCEPT_CONTENT_TYPE = "CamelAcceptContentType"; 077 String AGGREGATED_SIZE = "CamelAggregatedSize"; 078 String AGGREGATED_TIMEOUT = "CamelAggregatedTimeout"; 079 String AGGREGATED_COMPLETED_BY = "CamelAggregatedCompletedBy"; 080 String AGGREGATED_CORRELATION_KEY = "CamelAggregatedCorrelationKey"; 081 String AGGREGATED_COLLECTION_GUARD = "CamelAggregatedCollectionGuard"; 082 String AGGREGATION_STRATEGY = "CamelAggregationStrategy"; 083 String AGGREGATION_COMPLETE_CURRENT_GROUP = "CamelAggregationCompleteCurrentGroup"; 084 String AGGREGATION_COMPLETE_ALL_GROUPS = "CamelAggregationCompleteAllGroups"; 085 String AGGREGATION_COMPLETE_ALL_GROUPS_INCLUSIVE = "CamelAggregationCompleteAllGroupsInclusive"; 086 String ASYNC_WAIT = "CamelAsyncWait"; 087 088 String BATCH_INDEX = "CamelBatchIndex"; 089 String BATCH_SIZE = "CamelBatchSize"; 090 String BATCH_COMPLETE = "CamelBatchComplete"; 091 String BEAN_METHOD_NAME = "CamelBeanMethodName"; 092 String BINDING = "CamelBinding"; 093 // do not prefix with Camel and use lower-case starting letter as its a shared key 094 // used across other Apache products such as AMQ, SMX etc. 095 String BREADCRUMB_ID = "breadcrumbId"; 096 097 String CHARSET_NAME = "CamelCharsetName"; 098 String CIRCUIT_BREAKER_STATE = "CamelCircuitBreakerState"; 099 String CREATED_TIMESTAMP = "CamelCreatedTimestamp"; 100 String CLAIM_CHECK_REPOSITORY = "CamelClaimCheckRepository"; 101 String CONTENT_ENCODING = "Content-Encoding"; 102 String CONTENT_LENGTH = "Content-Length"; 103 String CONTENT_TYPE = "Content-Type"; 104 String COOKIE_HANDLER = "CamelCookieHandler"; 105 String CORRELATION_ID = "CamelCorrelationId"; 106 107 String DATASET_INDEX = "CamelDataSetIndex"; 108 String DEFAULT_CHARSET_PROPERTY = "org.apache.camel.default.charset"; 109 String DESTINATION_OVERRIDE_URL = "CamelDestinationOverrideUrl"; 110 String DISABLE_HTTP_STREAM_CACHE = "CamelDisableHttpStreamCache"; 111 String DUPLICATE_MESSAGE = "CamelDuplicateMessage"; 112 113 String DOCUMENT_BUILDER_FACTORY = "CamelDocumentBuilderFactory"; 114 115 String EXCEPTION_CAUGHT = "CamelExceptionCaught"; 116 String EXCEPTION_HANDLED = "CamelExceptionHandled"; 117 String EVALUATE_EXPRESSION_RESULT = "CamelEvaluateExpressionResult"; 118 String ERRORHANDLER_CIRCUIT_DETECTED = "CamelFErrorHandlerCircuitDetected"; 119 String ERRORHANDLER_HANDLED = "CamelErrorHandlerHandled"; 120 String EXTERNAL_REDELIVERED = "CamelExternalRedelivered"; 121 122 String FAILURE_HANDLED = "CamelFailureHandled"; 123 String FAILURE_ENDPOINT = "CamelFailureEndpoint"; 124 String FAILURE_ROUTE_ID = "CamelFailureRouteId"; 125 String FATAL_FALLBACK_ERROR_HANDLER = "CamelFatalFallbackErrorHandler"; 126 String FILE_CONTENT_TYPE = "CamelFileContentType"; 127 String FILE_LOCAL_WORK_PATH = "CamelFileLocalWorkPath"; 128 String FILE_NAME = "CamelFileName"; 129 String FILE_NAME_ONLY = "CamelFileNameOnly"; 130 String FILE_NAME_PRODUCED = "CamelFileNameProduced"; 131 String FILE_NAME_CONSUMED = "CamelFileNameConsumed"; 132 String FILE_PATH = "CamelFilePath"; 133 String FILE_PARENT = "CamelFileParent"; 134 String FILE_LAST_MODIFIED = "CamelFileLastModified"; 135 String FILE_LENGTH = "CamelFileLength"; 136 String FILE_LOCK_FILE_ACQUIRED = "CamelFileLockFileAcquired"; 137 String FILE_LOCK_FILE_NAME = "CamelFileLockFileName"; 138 String FILE_LOCK_EXCLUSIVE_LOCK = "CamelFileLockExclusiveLock"; 139 String FILE_LOCK_RANDOM_ACCESS_FILE = "CamelFileLockRandomAccessFile"; 140 String FILTER_MATCHED = "CamelFilterMatched"; 141 String FILTER_NON_XML_CHARS = "CamelFilterNonXmlChars"; 142 143 String GROUPED_EXCHANGE = "CamelGroupedExchange"; 144 145 String HTTP_SCHEME = "CamelHttpScheme"; 146 String HTTP_HOST = "CamelHttpHost"; 147 String HTTP_PORT = "CamelHttpPort"; 148 String HTTP_BASE_URI = "CamelHttpBaseUri"; 149 String HTTP_CHARACTER_ENCODING = "CamelHttpCharacterEncoding"; 150 String HTTP_METHOD = "CamelHttpMethod"; 151 String HTTP_PATH = "CamelHttpPath"; 152 String HTTP_PROTOCOL_VERSION = "CamelHttpProtocolVersion"; 153 String HTTP_QUERY = "CamelHttpQuery"; 154 String HTTP_RAW_QUERY = "CamelHttpRawQuery"; 155 String HTTP_RESPONSE_CODE = "CamelHttpResponseCode"; 156 String HTTP_RESPONSE_TEXT = "CamelHttpResponseText"; 157 String HTTP_URI = "CamelHttpUri"; 158 String HTTP_URL = "CamelHttpUrl"; 159 String HTTP_CHUNKED = "CamelHttpChunked"; 160 String HTTP_SERVLET_REQUEST = "CamelHttpServletRequest"; 161 String HTTP_SERVLET_RESPONSE = "CamelHttpServletResponse"; 162 163 String INTERCEPTED_ENDPOINT = "CamelInterceptedEndpoint"; 164 String INTERCEPT_SEND_TO_ENDPOINT_WHEN_MATCHED = "CamelInterceptSendToEndpointWhenMatched"; 165 String INTERRUPTED = "CamelInterrupted"; 166 167 String LANGUAGE_SCRIPT = "CamelLanguageScript"; 168 String LOG_DEBUG_BODY_MAX_CHARS = "CamelLogDebugBodyMaxChars"; 169 String LOG_DEBUG_BODY_STREAMS = "CamelLogDebugStreams"; 170 String LOG_EIP_NAME = "CamelLogEipName"; 171 String LOOP_INDEX = "CamelLoopIndex"; 172 String LOOP_SIZE = "CamelLoopSize"; 173 174 // Long running action (saga): using "Long-Running-Action" as header value allows sagas 175 // to be propagated to any remote system supporting the LRA framework 176 String SAGA_LONG_RUNNING_ACTION = "Long-Running-Action"; 177 178 String MAXIMUM_CACHE_POOL_SIZE = "CamelMaximumCachePoolSize"; 179 String MAXIMUM_ENDPOINT_CACHE_SIZE = "CamelMaximumEndpointCacheSize"; 180 String MAXIMUM_SIMPLE_CACHE_SIZE = "CamelMaximumSimpleCacheSize"; 181 String MAXIMUM_TRANSFORMER_CACHE_SIZE = "CamelMaximumTransformerCacheSize"; 182 String MAXIMUM_VALIDATOR_CACHE_SIZE = "CamelMaximumValidatorCacheSize"; 183 String MESSAGE_HISTORY = "CamelMessageHistory"; 184 String MESSAGE_HISTORY_HEADER_FORMAT = "CamelMessageHistoryHeaderFormat"; 185 String MESSAGE_HISTORY_OUTPUT_FORMAT = "CamelMessageHistoryOutputFormat"; 186 String MULTICAST_INDEX = "CamelMulticastIndex"; 187 String MULTICAST_COMPLETE = "CamelMulticastComplete"; 188 189 String NOTIFY_EVENT = "CamelNotifyEvent"; 190 191 String ON_COMPLETION = "CamelOnCompletion"; 192 String OVERRULE_FILE_NAME = "CamelOverruleFileName"; 193 194 String PARENT_UNIT_OF_WORK = "CamelParentUnitOfWork"; 195 String STREAM_CACHE_UNIT_OF_WORK = "CamelStreamCacheUnitOfWork"; 196 197 String RECIPIENT_LIST_ENDPOINT = "CamelRecipientListEndpoint"; 198 String RECEIVED_TIMESTAMP = "CamelReceivedTimestamp"; 199 String REDELIVERED = "CamelRedelivered"; 200 String REDELIVERY_COUNTER = "CamelRedeliveryCounter"; 201 String REDELIVERY_MAX_COUNTER = "CamelRedeliveryMaxCounter"; 202 String REDELIVERY_EXHAUSTED = "CamelRedeliveryExhausted"; 203 String REDELIVERY_DELAY = "CamelRedeliveryDelay"; 204 String REST_HTTP_URI = "CamelRestHttpUri"; 205 String REST_HTTP_QUERY = "CamelRestHttpQuery"; 206 String ROLLBACK_ONLY = "CamelRollbackOnly"; 207 String ROLLBACK_ONLY_LAST = "CamelRollbackOnlyLast"; 208 String ROUTE_STOP = "CamelRouteStop"; 209 210 String REUSE_SCRIPT_ENGINE = "CamelReuseScripteEngine"; 211 String COMPILE_SCRIPT = "CamelCompileScript"; 212 213 String SAXPARSER_FACTORY = "CamelSAXParserFactory"; 214 215 String SCHEDULER_POLLED_MESSAGES = "CamelSchedulerPolledMessages"; 216 String SOAP_ACTION = "CamelSoapAction"; 217 String SKIP_GZIP_ENCODING = "CamelSkipGzipEncoding"; 218 String SKIP_WWW_FORM_URLENCODED = "CamelSkipWwwFormUrlEncoding"; 219 String SLIP_ENDPOINT = "CamelSlipEndpoint"; 220 String SLIP_PRODUCER = "CamelSlipProducer"; 221 String SPLIT_INDEX = "CamelSplitIndex"; 222 String SPLIT_COMPLETE = "CamelSplitComplete"; 223 String SPLIT_SIZE = "CamelSplitSize"; 224 String STEP_ID = "CamelStepId"; 225 226 String TIMER_COUNTER = "CamelTimerCounter"; 227 String TIMER_FIRED_TIME = "CamelTimerFiredTime"; 228 String TIMER_NAME = "CamelTimerName"; 229 String TIMER_PERIOD = "CamelTimerPeriod"; 230 String TIMER_TIME = "CamelTimerTime"; 231 String TO_ENDPOINT = "CamelToEndpoint"; 232 String TRACE_EVENT = "CamelTraceEvent"; 233 String TRACE_EVENT_NODE_ID = "CamelTraceEventNodeId"; 234 String TRACE_EVENT_TIMESTAMP = "CamelTraceEventTimestamp"; 235 String TRACE_EVENT_EXCHANGE = "CamelTraceEventExchange"; 236 String TRY_ROUTE_BLOCK = "TryRouteBlock"; 237 String TRANSFER_ENCODING = "Transfer-Encoding"; 238 239 String UNIT_OF_WORK_EXHAUSTED = "CamelUnitOfWorkExhausted"; 240 241 /** 242 * @deprecated UNIT_OF_WORK_PROCESS_SYNC is not in use and will be removed in future Camel release 243 */ 244 @Deprecated 245 String UNIT_OF_WORK_PROCESS_SYNC = "CamelUnitOfWorkProcessSync"; 246 247 String XSLT_FILE_NAME = "CamelXsltFileName"; 248 String XSLT_ERROR = "CamelXsltError"; 249 String XSLT_FATAL_ERROR = "CamelXsltFatalError"; 250 String XSLT_WARNING = "CamelXsltWarning"; 251 252 /** 253 * Returns the {@link ExchangePattern} (MEP) of this exchange. 254 * 255 * @return the message exchange pattern of this exchange 256 */ 257 ExchangePattern getPattern(); 258 259 /** 260 * Allows the {@link ExchangePattern} (MEP) of this exchange to be customized. 261 * 262 * This typically won't be required as an exchange can be created with a specific MEP 263 * by calling {@link Endpoint#createExchange(ExchangePattern)} but it is here just in case 264 * it is needed. 265 * 266 * @param pattern the pattern 267 */ 268 void setPattern(ExchangePattern pattern); 269 270 /** 271 * Returns a property associated with this exchange by name 272 * 273 * @param name the name of the property 274 * @return the value of the given property or <tt>null</tt> if there is no property for 275 * the given name 276 */ 277 Object getProperty(String name); 278 279 /** 280 * Returns a property associated with this exchange by name 281 * 282 * @param name the name of the property 283 * @param defaultValue the default value to return if property was absent 284 * @return the value of the given property or <tt>defaultValue</tt> if there is no 285 * property for the given name 286 */ 287 Object getProperty(String name, Object defaultValue); 288 289 /** 290 * Returns a property associated with this exchange by name and specifying 291 * the type required 292 * 293 * @param name the name of the property 294 * @param type the type of the property 295 * @return the value of the given property or <tt>null</tt> if there is no property for 296 * the given name or <tt>null</tt> if it cannot be converted to the given type 297 */ 298 <T> T getProperty(String name, Class<T> type); 299 300 /** 301 * Returns a property associated with this exchange by name and specifying 302 * the type required 303 * 304 * @param name the name of the property 305 * @param defaultValue the default value to return if property was absent 306 * @param type the type of the property 307 * @return the value of the given property or <tt>defaultValue</tt> if there is no property for 308 * the given name or <tt>null</tt> if it cannot be converted to the given type 309 */ 310 <T> T getProperty(String name, Object defaultValue, Class<T> type); 311 312 /** 313 * Sets a property on the exchange 314 * 315 * @param name of the property 316 * @param value to associate with the name 317 */ 318 void setProperty(String name, Object value); 319 320 /** 321 * Removes the given property on the exchange 322 * 323 * @param name of the property 324 * @return the old value of the property 325 */ 326 Object removeProperty(String name); 327 328 /** 329 * Remove all of the properties associated with the exchange matching a specific pattern 330 * 331 * @param pattern pattern of names 332 * @return boolean whether any properties matched 333 */ 334 boolean removeProperties(String pattern); 335 336 /** 337 * Removes the properties from this exchange that match the given <tt>pattern</tt>, 338 * except for the ones matching one ore more <tt>excludePatterns</tt> 339 * 340 * @param pattern pattern of names that should be removed 341 * @param excludePatterns one or more pattern of properties names that should be excluded (= preserved) 342 * @return boolean whether any properties matched 343 */ 344 boolean removeProperties(String pattern, String... excludePatterns); 345 346 /** 347 * Returns all of the properties associated with the exchange 348 * 349 * @return all the headers in a Map 350 */ 351 Map<String, Object> getProperties(); 352 353 /** 354 * Returns whether any properties has been set 355 * 356 * @return <tt>true</tt> if any properties has been set 357 */ 358 boolean hasProperties(); 359 360 /** 361 * Returns the inbound request message 362 * 363 * @return the message 364 */ 365 Message getIn(); 366 367 /** 368 * Returns the current message 369 * 370 * @return the current message 371 */ 372 Message getMessage(); 373 374 /** 375 * Returns the current message as the given type 376 * 377 * @param type the given type 378 * @return the message as the given type or <tt>null</tt> if not possible to covert to given type 379 */ 380 <T> T getMessage(Class<T> type); 381 382 /** 383 * Replace the current message instance. 384 * 385 * @param message the new message 386 */ 387 void setMessage(Message message); 388 389 /** 390 * Returns the inbound request message as the given type 391 * 392 * @param type the given type 393 * @return the message as the given type or <tt>null</tt> if not possible to covert to given type 394 */ 395 <T> T getIn(Class<T> type); 396 397 /** 398 * Sets the inbound message instance 399 * 400 * @param in the inbound message 401 */ 402 void setIn(Message in); 403 404 /** 405 * Returns the outbound message, lazily creating one if one has not already 406 * been associated with this exchange. 407 * <p/> 408 * <br/><b>Important:</b> If you want to change the current message, then use {@link #getIn()} instead as it will 409 * ensure headers etc. is kept and propagated when routing continues. Bottom line end users should rarely use 410 * this method. 411 * <p/> 412 * <br/>If you want to test whether an OUT message have been set or not, use the {@link #hasOut()} method. 413 * <p/> 414 * See also the class java doc for this {@link Exchange} for more details and this 415 * <a href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html">FAQ entry</a>. 416 * 417 * @return the response 418 * @see #getIn() 419 */ 420 Message getOut(); 421 422 /** 423 * Returns the outbound request message as the given type 424 * <p/> 425 * <br/><b>Important:</b> If you want to change the current message, then use {@link #getIn()} instead as it will 426 * ensure headers etc. is kept and propagated when routing continues. Bottom line end users should rarely use 427 * this method. 428 * <p/> 429 * <br/>If you want to test whether an OUT message have been set or not, use the {@link #hasOut()} method. 430 * <p/> 431 * See also the class java doc for this {@link Exchange} for more details and this 432 * <a href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html">FAQ entry</a>. 433 * 434 * @param type the given type 435 * @return the message as the given type or <tt>null</tt> if not possible to covert to given type 436 * @see #getIn(Class) 437 */ 438 <T> T getOut(Class<T> type); 439 440 /** 441 * Returns whether an OUT message has been set or not. 442 * 443 * @return <tt>true</tt> if an OUT message exists, <tt>false</tt> otherwise. 444 */ 445 boolean hasOut(); 446 447 /** 448 * Sets the outbound message 449 * 450 * @param out the outbound message 451 */ 452 void setOut(Message out); 453 454 /** 455 * Returns the exception associated with this exchange 456 * 457 * @return the exception (or null if no faults) 458 */ 459 Exception getException(); 460 461 /** 462 * Returns the exception associated with this exchange. 463 * <p/> 464 * Is used to get the caused exception that typically have been wrapped in some sort 465 * of Camel wrapper exception 466 * <p/> 467 * The strategy is to look in the exception hierarchy to find the first given cause that matches the type. 468 * Will start from the bottom (the real cause) and walk upwards. 469 * 470 * @param type the exception type 471 * @return the exception (or <tt>null</tt> if no caused exception matched) 472 */ 473 <T> T getException(Class<T> type); 474 475 /** 476 * Sets the exception associated with this exchange 477 * <p/> 478 * Camel will wrap {@link Throwable} into {@link Exception} type to 479 * accommodate for the {@link #getException()} method returning a plain {@link Exception} type. 480 * 481 * @param t the caused exception 482 */ 483 void setException(Throwable t); 484 485 /** 486 * Returns true if this exchange failed due to either an exception or fault 487 * 488 * @return true if this exchange failed due to either an exception or fault 489 * @see Exchange#getException() 490 * @see Message#setFault(boolean) 491 * @see Message#isFault() 492 */ 493 boolean isFailed(); 494 495 /** 496 * Returns true if this exchange is transacted 497 */ 498 boolean isTransacted(); 499 500 /** 501 * Returns true if this exchange is an external initiated redelivered message (such as a JMS broker). 502 * <p/> 503 * <b>Important: </b> It is not always possible to determine if the message is a redelivery 504 * or not, and therefore <tt>null</tt> is returned. Such an example would be a JDBC message. 505 * However JMS brokers provides details if a message is redelivered. 506 * 507 * @return <tt>true</tt> if redelivered, <tt>false</tt> if not, <tt>null</tt> if not able to determine 508 */ 509 Boolean isExternalRedelivered(); 510 511 /** 512 * Returns true if this exchange is marked for rollback 513 */ 514 boolean isRollbackOnly(); 515 516 /** 517 * Returns the container so that a processor can resolve endpoints from URIs 518 * 519 * @return the container which owns this exchange 520 */ 521 CamelContext getContext(); 522 523 /** 524 * Creates a copy of the current message exchange so that it can be 525 * forwarded to another destination 526 */ 527 Exchange copy(); 528 529 /** 530 * Returns the endpoint which originated this message exchange if a consumer on an endpoint 531 * created the message exchange, otherwise this property will be <tt>null</tt> 532 */ 533 Endpoint getFromEndpoint(); 534 535 /** 536 * Sets the endpoint which originated this message exchange. This method 537 * should typically only be called by {@link org.apache.camel.Endpoint} implementations 538 * 539 * @param fromEndpoint the endpoint which is originating this message exchange 540 */ 541 void setFromEndpoint(Endpoint fromEndpoint); 542 543 /** 544 * Returns the route id which originated this message exchange if a route consumer on an endpoint 545 * created the message exchange, otherwise this property will be <tt>null</tt> 546 */ 547 String getFromRouteId(); 548 549 /** 550 * Sets the route id which originated this message exchange. This method 551 * should typically only be called by the internal framework. 552 * 553 * @param fromRouteId the from route id 554 */ 555 void setFromRouteId(String fromRouteId); 556 557 /** 558 * Returns the unit of work that this exchange belongs to; which may map to 559 * zero, one or more physical transactions 560 */ 561 UnitOfWork getUnitOfWork(); 562 563 /** 564 * Sets the unit of work that this exchange belongs to; which may map to 565 * zero, one or more physical transactions 566 */ 567 void setUnitOfWork(UnitOfWork unitOfWork); 568 569 /** 570 * Returns the exchange id (unique) 571 */ 572 String getExchangeId(); 573 574 /** 575 * Set the exchange id 576 */ 577 void setExchangeId(String id); 578 579 /** 580 * Adds a {@link org.apache.camel.spi.Synchronization} to be invoked as callback when 581 * this exchange is completed. 582 * 583 * @param onCompletion the callback to invoke on completion of this exchange 584 */ 585 void addOnCompletion(Synchronization onCompletion); 586 587 /** 588 * Checks if the passed {@link org.apache.camel.spi.Synchronization} instance is 589 * already contained on this exchange. 590 * 591 * @param onCompletion the callback instance that is being checked for 592 * @return <tt>true</tt>, if callback instance is already contained on this exchange, else <tt>false</tt> 593 */ 594 boolean containsOnCompletion(Synchronization onCompletion); 595 596 /** 597 * Handover all the on completions from this exchange to the target exchange. 598 * 599 * @param target the target exchange 600 */ 601 void handoverCompletions(Exchange target); 602 603 /** 604 * Handover all the on completions from this exchange 605 * 606 * @return the on completions 607 */ 608 List<Synchronization> handoverCompletions(); 609 610 /** 611 * Gets the timestamp when this exchange was created. 612 */ 613 Date getCreated(); 614 615}