Package org.apache.camel.spi
Interface DataFormat
- All Superinterfaces:
AutoCloseable
,Service
Represents a data format used to marshal objects to and from
streams such as Java Serialization or using JAXB2 to encode/decode objects using XML or using SOAP encoding.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
marshal
(Exchange exchange, Object graph, OutputStream stream) Marshals the object to the given Stream.unmarshal
(Exchange exchange, InputStream stream) Unmarshals the given stream into an object.default Object
Unmarshals the given body into an object.
-
Method Details
-
marshal
Marshals the object to the given Stream.- Parameters:
exchange
- the current exchangegraph
- the object to be marshalledstream
- the output stream to write the marshalled result to- Throws:
Exception
- can be thrown
-
unmarshal
Unmarshals the given stream into an object. Notice: The result is set as body on the exchange OUT message. It is possible to mutate the OUT message provided in the given exchange parameter. For instance adding headers to the OUT message will be preserved. It's also legal to return the same passed exchange as is but also aMessage
object as well which will be used as the OUT message of exchange.- Parameters:
exchange
- the current exchangestream
- the input stream with the object to be unmarshalled- Returns:
- the unmarshalled object
- Throws:
Exception
- can be thrown- See Also:
-
unmarshal
Unmarshals the given body into an object. Notice: The result is set as body on the exchange OUT message. It is possible to mutate the OUT message provided in the given exchange parameter. For instance adding headers to the OUT message will be preserved. It's also legal to return the same passed exchange as is but also aMessage
object as well which will be used as the OUT message of exchange. This method can be used when a dataformat is optimized to handle any kind of message body as-is. For example camel-jaxb has been optimized to do this. The regularunmarshal(Exchange, InputStream)
method requires Camel to convert the message body into anInputStream
prior to calling the unmarshal method. This can be avoided if the data-format implementation can be optimized to handle this by itself, such as camel-jaxb that can handle message body as a String payload out of the box. When a data format implementation is using this method, then theunmarshal(Exchange, InputStream)
must also be implemented but should be empty, as Camel will not invoke this method.- Parameters:
exchange
- the current exchangebody
- the input object to be unmarshalled- Returns:
- the unmarshalled object
- Throws:
Exception
- can be thrown
-