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.impl.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 * 071 */ 072public interface Exchange { 073 074 String AUTHENTICATION = "CamelAuthentication"; 075 String AUTHENTICATION_FAILURE_POLICY_ID = "CamelAuthenticationFailurePolicyId"; 076 @Deprecated 077 String ACCEPT_CONTENT_TYPE = "CamelAcceptContentType"; 078 String AGGREGATED_SIZE = "CamelAggregatedSize"; 079 String AGGREGATED_TIMEOUT = "CamelAggregatedTimeout"; 080 String AGGREGATED_COMPLETED_BY = "CamelAggregatedCompletedBy"; 081 String AGGREGATED_CORRELATION_KEY = "CamelAggregatedCorrelationKey"; 082 String AGGREGATED_COLLECTION_GUARD = "CamelAggregatedCollectionGuard"; 083 String AGGREGATION_STRATEGY = "CamelAggregationStrategy"; 084 String AGGREGATION_COMPLETE_CURRENT_GROUP = "CamelAggregationCompleteCurrentGroup"; 085 String AGGREGATION_COMPLETE_ALL_GROUPS = "CamelAggregationCompleteAllGroups"; 086 String AGGREGATION_COMPLETE_ALL_GROUPS_INCLUSIVE = "CamelAggregationCompleteAllGroupsInclusive"; 087 String ASYNC_WAIT = "CamelAsyncWait"; 088 089 String BATCH_INDEX = "CamelBatchIndex"; 090 String BATCH_SIZE = "CamelBatchSize"; 091 String BATCH_COMPLETE = "CamelBatchComplete"; 092 String BEAN_METHOD_NAME = "CamelBeanMethodName"; 093 @Deprecated 094 String BEAN_MULTI_PARAMETER_ARRAY = "CamelBeanMultiParameterArray"; 095 String BINDING = "CamelBinding"; 096 // do not prefix with Camel and use lower-case starting letter as its a shared key 097 // used across other Apache products such as AMQ, SMX etc. 098 String BREADCRUMB_ID = "breadcrumbId"; 099 100 String CHARSET_NAME = "CamelCharsetName"; 101 String CIRCUIT_BREAKER_STATE = "CamelCircuitBreakerState"; 102 String CREATED_TIMESTAMP = "CamelCreatedTimestamp"; 103 String CLAIM_CHECK_REPOSITORY = "CamelClaimCheckRepository"; 104 String CONTENT_ENCODING = "Content-Encoding"; 105 String CONTENT_LENGTH = "Content-Length"; 106 String CONTENT_TYPE = "Content-Type"; 107 String COOKIE_HANDLER = "CamelCookieHandler"; 108 String CORRELATION_ID = "CamelCorrelationId"; 109 110 String DATASET_INDEX = "CamelDataSetIndex"; 111 String DEFAULT_CHARSET_PROPERTY = "org.apache.camel.default.charset"; 112 String DESTINATION_OVERRIDE_URL = "CamelDestinationOverrideUrl"; 113 String DISABLE_HTTP_STREAM_CACHE = "CamelDisableHttpStreamCache"; 114 String DUPLICATE_MESSAGE = "CamelDuplicateMessage"; 115 116 String DOCUMENT_BUILDER_FACTORY = "CamelDocumentBuilderFactory"; 117 118 String EXCEPTION_CAUGHT = "CamelExceptionCaught"; 119 String EXCEPTION_HANDLED = "CamelExceptionHandled"; 120 String EVALUATE_EXPRESSION_RESULT = "CamelEvaluateExpressionResult"; 121 String ERRORHANDLER_CIRCUIT_DETECTED = "CamelFErrorHandlerCircuitDetected"; 122 String ERRORHANDLER_HANDLED = "CamelErrorHandlerHandled"; 123 String EXTERNAL_REDELIVERED = "CamelExternalRedelivered"; 124 125 String FAILURE_HANDLED = "CamelFailureHandled"; 126 String FAILURE_ENDPOINT = "CamelFailureEndpoint"; 127 String FAILURE_ROUTE_ID = "CamelFailureRouteId"; 128 String FATAL_FALLBACK_ERROR_HANDLER = "CamelFatalFallbackErrorHandler"; 129 String FILE_CONTENT_TYPE = "CamelFileContentType"; 130 String FILE_LOCAL_WORK_PATH = "CamelFileLocalWorkPath"; 131 String FILE_NAME = "CamelFileName"; 132 String FILE_NAME_ONLY = "CamelFileNameOnly"; 133 String FILE_NAME_PRODUCED = "CamelFileNameProduced"; 134 String FILE_NAME_CONSUMED = "CamelFileNameConsumed"; 135 String FILE_PATH = "CamelFilePath"; 136 String FILE_PARENT = "CamelFileParent"; 137 String FILE_LAST_MODIFIED = "CamelFileLastModified"; 138 String FILE_LENGTH = "CamelFileLength"; 139 String FILE_LOCK_FILE_ACQUIRED = "CamelFileLockFileAcquired"; 140 String FILE_LOCK_FILE_NAME = "CamelFileLockFileName"; 141 String FILE_LOCK_EXCLUSIVE_LOCK = "CamelFileLockExclusiveLock"; 142 String FILE_LOCK_RANDOM_ACCESS_FILE = "CamelFileLockRandomAccessFile"; 143 String FILTER_MATCHED = "CamelFilterMatched"; 144 String FILTER_NON_XML_CHARS = "CamelFilterNonXmlChars"; 145 146 String GROUPED_EXCHANGE = "CamelGroupedExchange"; 147 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 225 String TIMER_COUNTER = "CamelTimerCounter"; 226 String TIMER_FIRED_TIME = "CamelTimerFiredTime"; 227 String TIMER_NAME = "CamelTimerName"; 228 String TIMER_PERIOD = "CamelTimerPeriod"; 229 String TIMER_TIME = "CamelTimerTime"; 230 String TO_ENDPOINT = "CamelToEndpoint"; 231 String TRACE_EVENT = "CamelTraceEvent"; 232 String TRACE_EVENT_NODE_ID = "CamelTraceEventNodeId"; 233 String TRACE_EVENT_TIMESTAMP = "CamelTraceEventTimestamp"; 234 String TRACE_EVENT_EXCHANGE = "CamelTraceEventExchange"; 235 String TRY_ROUTE_BLOCK = "TryRouteBlock"; 236 String TRANSFER_ENCODING = "Transfer-Encoding"; 237 238 String UNIT_OF_WORK_EXHAUSTED = "CamelUnitOfWorkExhausted"; 239 240 /** 241 * @deprecated UNIT_OF_WORK_PROCESS_SYNC is not in use and will be removed in future Camel release 242 */ 243 @Deprecated 244 String UNIT_OF_WORK_PROCESS_SYNC = "CamelUnitOfWorkProcessSync"; 245 246 String XSLT_FILE_NAME = "CamelXsltFileName"; 247 String XSLT_ERROR = "CamelXsltError"; 248 String XSLT_FATAL_ERROR = "CamelXsltFatalError"; 249 String XSLT_WARNING = "CamelXsltWarning"; 250 251 /** 252 * Returns the {@link ExchangePattern} (MEP) of this exchange. 253 * 254 * @return the message exchange pattern of this exchange 255 */ 256 ExchangePattern getPattern(); 257 258 /** 259 * Allows the {@link ExchangePattern} (MEP) of this exchange to be customized. 260 * 261 * This typically won't be required as an exchange can be created with a specific MEP 262 * by calling {@link Endpoint#createExchange(ExchangePattern)} but it is here just in case 263 * it is needed. 264 * 265 * @param pattern the pattern 266 */ 267 void setPattern(ExchangePattern pattern); 268 269 /** 270 * Returns a property associated with this exchange by name 271 * 272 * @param name the name of the property 273 * @return the value of the given property or <tt>null</tt> if there is no property for 274 * the given name 275 */ 276 Object getProperty(String name); 277 278 /** 279 * Returns a property associated with this exchange by name 280 * 281 * @param name the name of the property 282 * @param defaultValue the default value to return if property was absent 283 * @return the value of the given property or <tt>defaultValue</tt> if there is no 284 * property for the given name 285 */ 286 Object getProperty(String name, Object defaultValue); 287 288 /** 289 * Returns a property associated with this exchange by name and specifying 290 * the type required 291 * 292 * @param name the name of the property 293 * @param type the type of the property 294 * @return the value of the given property or <tt>null</tt> if there is no property for 295 * the given name or <tt>null</tt> if it cannot be converted to the given type 296 */ 297 <T> T getProperty(String name, Class<T> type); 298 299 /** 300 * Returns a property associated with this exchange by name and specifying 301 * the type required 302 * 303 * @param name the name of the property 304 * @param defaultValue the default value to return if property was absent 305 * @param type the type of the property 306 * @return the value of the given property or <tt>defaultValue</tt> if there is no property for 307 * the given name or <tt>null</tt> if it cannot be converted to the given type 308 */ 309 <T> T getProperty(String name, Object defaultValue, Class<T> type); 310 311 /** 312 * Sets a property on the exchange 313 * 314 * @param name of the property 315 * @param value to associate with the name 316 */ 317 void setProperty(String name, Object value); 318 319 /** 320 * Removes the given property on the exchange 321 * 322 * @param name of the property 323 * @return the old value of the property 324 */ 325 Object removeProperty(String name); 326 327 /** 328 * Remove all of the properties associated with the exchange matching a specific pattern 329 * 330 * @param pattern pattern of names 331 * @return boolean whether any properties matched 332 */ 333 boolean removeProperties(String pattern); 334 335 /** 336 * Removes the properties from this exchange that match the given <tt>pattern</tt>, 337 * except for the ones matching one ore more <tt>excludePatterns</tt> 338 * 339 * @param pattern pattern of names that should be removed 340 * @param excludePatterns one or more pattern of properties names that should be excluded (= preserved) 341 * @return boolean whether any properties matched 342 */ 343 boolean removeProperties(String pattern, String... excludePatterns); 344 345 /** 346 * Returns all of the properties associated with the exchange 347 * 348 * @return all the headers in a Map 349 */ 350 Map<String, Object> getProperties(); 351 352 /** 353 * Returns whether any properties has been set 354 * 355 * @return <tt>true</tt> if any properties has been set 356 */ 357 boolean hasProperties(); 358 359 /** 360 * Returns the inbound request message 361 * 362 * @return the message 363 */ 364 Message getIn(); 365 366 /** 367 * Returns the current message 368 * 369 * @return the current message 370 */ 371 Message getMessage(); 372 373 /** 374 * Returns the current message as the given type 375 * 376 * @param type the given type 377 * @return the message as the given type or <tt>null</tt> if not possible to covert to given type 378 */ 379 <T> T getMessage(Class<T> type); 380 381 /** 382 * Replace the current message instance. 383 * 384 * @param message the new message 385 */ 386 void setMessage(Message message); 387 388 /** 389 * Returns the inbound request message as the given type 390 * 391 * @param type the given type 392 * @return the message as the given type or <tt>null</tt> if not possible to covert to given type 393 */ 394 <T> T getIn(Class<T> type); 395 396 /** 397 * Sets the inbound message instance 398 * 399 * @param in the inbound message 400 */ 401 void setIn(Message in); 402 403 /** 404 * Returns the outbound message, lazily creating one if one has not already 405 * been associated with this exchange. 406 * <p/> 407 * <br/><b>Important:</b> If you want to change the current message, then use {@link #getIn()} instead as it will 408 * ensure headers etc. is kept and propagated when routing continues. Bottom line end users should rarely use 409 * this method. 410 * <p/> 411 * <br/>If you want to test whether an OUT message have been set or not, use the {@link #hasOut()} method. 412 * <p/> 413 * See also the class java doc for this {@link Exchange} for more details and this 414 * <a href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html">FAQ entry</a>. 415 * 416 * @return the response 417 * @see #getIn() 418 */ 419 Message getOut(); 420 421 /** 422 * Returns the outbound request message as the given type 423 * <p/> 424 * <br/><b>Important:</b> If you want to change the current message, then use {@link #getIn()} instead as it will 425 * ensure headers etc. is kept and propagated when routing continues. Bottom line end users should rarely use 426 * this method. 427 * <p/> 428 * <br/>If you want to test whether an OUT message have been set or not, use the {@link #hasOut()} method. 429 * <p/> 430 * See also the class java doc for this {@link Exchange} for more details and this 431 * <a href="http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html">FAQ entry</a>. 432 * 433 * @param type the given type 434 * @return the message as the given type or <tt>null</tt> if not possible to covert to given type 435 * @see #getIn(Class) 436 */ 437 <T> T getOut(Class<T> type); 438 439 /** 440 * Returns whether an OUT message has been set or not. 441 * 442 * @return <tt>true</tt> if an OUT message exists, <tt>false</tt> otherwise. 443 */ 444 boolean hasOut(); 445 446 /** 447 * Sets the outbound message 448 * 449 * @param out the outbound message 450 */ 451 void setOut(Message out); 452 453 /** 454 * Returns the exception associated with this exchange 455 * 456 * @return the exception (or null if no faults) 457 */ 458 Exception getException(); 459 460 /** 461 * Returns the exception associated with this exchange. 462 * <p/> 463 * Is used to get the caused exception that typically have been wrapped in some sort 464 * of Camel wrapper exception 465 * <p/> 466 * The strategy is to look in the exception hierarchy to find the first given cause that matches the type. 467 * Will start from the bottom (the real cause) and walk upwards. 468 * 469 * @param type the exception type 470 * @return the exception (or <tt>null</tt> if no caused exception matched) 471 */ 472 <T> T getException(Class<T> type); 473 474 /** 475 * Sets the exception associated with this exchange 476 * <p/> 477 * Camel will wrap {@link Throwable} into {@link Exception} type to 478 * accommodate for the {@link #getException()} method returning a plain {@link Exception} type. 479 * 480 * @param t the caused exception 481 */ 482 void setException(Throwable t); 483 484 /** 485 * Returns true if this exchange failed due to either an exception or fault 486 * 487 * @return true if this exchange failed due to either an exception or fault 488 * @see Exchange#getException() 489 * @see Message#setFault(boolean) 490 * @see Message#isFault() 491 */ 492 boolean isFailed(); 493 494 /** 495 * Returns true if this exchange is transacted 496 */ 497 boolean isTransacted(); 498 499 /** 500 * Returns true if this exchange is an external initiated redelivered message (such as a JMS broker). 501 * <p/> 502 * <b>Important: </b> It is not always possible to determine if the message is a redelivery 503 * or not, and therefore <tt>null</tt> is returned. Such an example would be a JDBC message. 504 * However JMS brokers provides details if a message is redelivered. 505 * 506 * @return <tt>true</tt> if redelivered, <tt>false</tt> if not, <tt>null</tt> if not able to determine 507 */ 508 Boolean isExternalRedelivered(); 509 510 /** 511 * Returns true if this exchange is marked for rollback 512 */ 513 boolean isRollbackOnly(); 514 515 /** 516 * Returns the container so that a processor can resolve endpoints from URIs 517 * 518 * @return the container which owns this exchange 519 */ 520 CamelContext getContext(); 521 522 /** 523 * Creates a copy of the current message exchange so that it can be 524 * forwarded to another destination 525 * <p/> 526 * Notice this operation invokes <tt>copy(false)</tt> 527 */ 528 Exchange copy(); 529 530 /** 531 * Creates a copy of the current message exchange so that it can be 532 * forwarded to another destination 533 * 534 * @param safeCopy whether to copy exchange properties and message headers safely to a new map instance, 535 * or allow sharing the same map instances in the returned copy. 536 */ 537 Exchange copy(boolean safeCopy); 538 539 /** 540 * Returns the endpoint which originated this message exchange if a consumer on an endpoint 541 * created the message exchange, otherwise this property will be <tt>null</tt> 542 */ 543 Endpoint getFromEndpoint(); 544 545 /** 546 * Sets the endpoint which originated this message exchange. This method 547 * should typically only be called by {@link org.apache.camel.Endpoint} implementations 548 * 549 * @param fromEndpoint the endpoint which is originating this message exchange 550 */ 551 void setFromEndpoint(Endpoint fromEndpoint); 552 553 /** 554 * Returns the route id which originated this message exchange if a route consumer on an endpoint 555 * created the message exchange, otherwise this property will be <tt>null</tt> 556 */ 557 String getFromRouteId(); 558 559 /** 560 * Sets the route id which originated this message exchange. This method 561 * should typically only be called by the internal framework. 562 * 563 * @param fromRouteId the from route id 564 */ 565 void setFromRouteId(String fromRouteId); 566 567 /** 568 * Returns the unit of work that this exchange belongs to; which may map to 569 * zero, one or more physical transactions 570 */ 571 UnitOfWork getUnitOfWork(); 572 573 /** 574 * Sets the unit of work that this exchange belongs to; which may map to 575 * zero, one or more physical transactions 576 */ 577 void setUnitOfWork(UnitOfWork unitOfWork); 578 579 /** 580 * Returns the exchange id (unique) 581 */ 582 String getExchangeId(); 583 584 /** 585 * Set the exchange id 586 */ 587 void setExchangeId(String id); 588 589 /** 590 * Adds a {@link org.apache.camel.spi.Synchronization} to be invoked as callback when 591 * this exchange is completed. 592 * 593 * @param onCompletion the callback to invoke on completion of this exchange 594 */ 595 void addOnCompletion(Synchronization onCompletion); 596 597 /** 598 * Checks if the passed {@link org.apache.camel.spi.Synchronization} instance is 599 * already contained on this exchange. 600 * 601 * @param onCompletion the callback instance that is being checked for 602 * @return <tt>true</tt>, if callback instance is already contained on this exchange, else <tt>false</tt> 603 */ 604 boolean containsOnCompletion(Synchronization onCompletion); 605 606 /** 607 * Handover all the on completions from this exchange to the target exchange. 608 * 609 * @param target the target exchange 610 */ 611 void handoverCompletions(Exchange target); 612 613 /** 614 * Handover all the on completions from this exchange 615 * 616 * @return the on completions 617 */ 618 List<Synchronization> handoverCompletions(); 619 620 /** 621 * Gets the timestamp when this exchange was created. 622 */ 623 Date getCreated(); 624 625}