org.apache.camel
Interface Exchange

All Known Implementing Classes:
BeanExchange, DefaultExchange, FileExchange, JMXExchange

public interface Exchange

The base message exchange interface providing access to the request, response and fault Message instances. Different providers such as JMS, JBI, CXF and HTTP can provide their own derived API to expose the underlying transport semantics to avoid the leaky abstractions of generic APIs.

Version:
$Revision: 36635 $

Method Summary
 Exchange copy()
          Creates a copy of the current message exchange so that it can be forwarded to another destination
 void copyFrom(Exchange source)
          Copies the data into this exchange from the given exchange
 CamelContext getContext()
          Returns the container so that a processor can resolve endpoints from URIs
 Throwable getException()
          Returns the exception associated with this exchange
 String getExchangeId()
          Returns the exchange id
 Message getFault()
          Returns the fault message
 Message getFault(boolean lazyCreate)
          Returns the fault message; optionally lazily creating one if one has not been associated with this exchange
 Message getIn()
          Returns the inbound request message
 Message getOut()
          Returns the outbound message, lazily creating one if one has not already been associated with this exchange.
 Message getOut(boolean lazyCreate)
          Returns the outbound message; optionally lazily creating one if one has not been associated with this exchange
 ExchangePattern getPattern()
          Returns the ExchangePattern (MEP) of this exchange.
 Map<String,Object> getProperties()
          Returns all of the properties associated with the exchange
 Object getProperty(String name)
          Returns a property associated with this exchange by name
<T> T
getProperty(String name, Class<T> type)
          Returns a property associated with this exchange by name and specifying the type required
 UnitOfWork getUnitOfWork()
          Returns the unit of work that this exchange belongs to; which may map to zero, one or more physical transactions
 boolean isFailed()
          Returns true if this exchange failed due to either an exception or fault
 Exchange newInstance()
          Creates a new exchange instance with empty messages, headers and properties
 Object removeProperty(String name)
          Removes the given property on the exchange
 void setException(Throwable e)
          Sets the exception associated with this exchange
 void setExchangeId(String id)
          Set the exchange id
 void setIn(Message in)
          Sets the inbound message instance
 void setOut(Message out)
          Sets the outbound message
 void setProperty(String name, Object value)
          Sets a property on the exchange
 void setUnitOfWork(UnitOfWork unitOfWork)
          Sets the unit of work that this exchange belongs to; which may map to zero, one or more physical transactions
 

Method Detail

getPattern

ExchangePattern getPattern()
Returns the ExchangePattern (MEP) of this exchange.

Returns:
the message exchange pattern of this exchange

getProperty

Object getProperty(String name)
Returns a property associated with this exchange by name

Parameters:
name - the name of the property
Returns:
the value of the given header or null if there is no property for the given name

getProperty

<T> T getProperty(String name,
                  Class<T> type)
Returns a property associated with this exchange by name and specifying the type required

Parameters:
name - the name of the property
type - the type of the property
Returns:
the value of the given header or null if there is no property for the given name or null if it cannot be converted to the given type

setProperty

void setProperty(String name,
                 Object value)
Sets a property on the exchange

Parameters:
name - of the property
value - to associate with the name

removeProperty

Object removeProperty(String name)
Removes the given property on the exchange

Parameters:
name - of the property
Returns:
the old value of the property

getProperties

Map<String,Object> getProperties()
Returns all of the properties associated with the exchange

Returns:
all the headers in a Map

getIn

Message getIn()
Returns the inbound request message

Returns:
the message

setIn

void setIn(Message in)
Sets the inbound message instance

Parameters:
in - the inbound message

getOut

Message getOut()
Returns the outbound message, lazily creating one if one has not already been associated with this exchange. If you want to inspect this property but not force lazy creation then invoke the getOut(boolean) method passing in false

Returns:
the response

getOut

Message getOut(boolean lazyCreate)
Returns the outbound message; optionally lazily creating one if one has not been associated with this exchange

Returns:
the response

setOut

void setOut(Message out)
Sets the outbound message

Parameters:
out - the outbound message

getFault

Message getFault()
Returns the fault message

Returns:
the fault

getFault

Message getFault(boolean lazyCreate)
Returns the fault message; optionally lazily creating one if one has not been associated with this exchange

Parameters:
lazyCreate - true will lazy create the fault message
Returns:
the fault

getException

Throwable getException()
Returns the exception associated with this exchange

Returns:
the exception (or null if no faults)

setException

void setException(Throwable e)
Sets the exception associated with this exchange

Parameters:
e - the caused exception

isFailed

boolean isFailed()
Returns true if this exchange failed due to either an exception or fault

Returns:
true if this exchange failed due to either an exception or fault
See Also:
getException(), getFault()

getContext

CamelContext getContext()
Returns the container so that a processor can resolve endpoints from URIs

Returns:
the container which owns this exchange

newInstance

Exchange newInstance()
Creates a new exchange instance with empty messages, headers and properties


copy

Exchange copy()
Creates a copy of the current message exchange so that it can be forwarded to another destination


copyFrom

void copyFrom(Exchange source)
Copies the data into this exchange from the given exchange

Parameters:
source - is the source from which headers and messages will be copied

getUnitOfWork

UnitOfWork getUnitOfWork()
Returns the unit of work that this exchange belongs to; which may map to zero, one or more physical transactions


setUnitOfWork

void setUnitOfWork(UnitOfWork unitOfWork)
Sets the unit of work that this exchange belongs to; which may map to zero, one or more physical transactions


getExchangeId

String getExchangeId()
Returns the exchange id

Returns:
the unique id of the exchange

setExchangeId

void setExchangeId(String id)
Set the exchange id

Parameters:
id -


Copyright © 2008 IONA Open Source Community. All Rights Reserved.