Interface DataFormat

  • All Superinterfaces:
    AutoCloseable, Service

    public interface DataFormat
    extends 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 Detail

      • marshal

        void marshal​(Exchange exchange,
                     Object graph,
                     OutputStream stream)
              throws Exception
        Marshals the object to the given Stream.
        Parameters:
        exchange - the current exchange
        graph - the object to be marshalled
        stream - the output stream to write the marshalled result to
        Throws:
        Exception - can be thrown
      • unmarshal

        Object unmarshal​(Exchange exchange,
                         InputStream stream)
                  throws Exception
        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 a Message object as well which will be used as the OUT message of exchange.

        Parameters:
        exchange - the current exchange
        stream - the input stream with the object to be unmarshalled
        Returns:
        the unmarshalled object
        Throws:
        Exception - can be thrown