View Javadoc

1   /*
2    * $Id: MuleMessageFactory.java 19191 2010-08-25 21:05:23Z tcarlson $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.api.transport;
12  
13  import org.mule.api.MuleMessage;
14  
15  /**
16   * <code>MuleMessageFactory</code> is a factory for creating a {@link MuleMessage} from a transport's
17   * native message format (e.g. JMS message).
18   */
19  public interface MuleMessageFactory
20  {
21      /**
22       * Creates a {@link MuleMessage} instance from <code>transportMessage</code> by extracting
23       * its payload and, if available, any relevant message properties and attachments.
24       */
25      MuleMessage create(Object transportMessage, String encoding) throws Exception;
26  
27      /**
28       * Creates a {@link MuleMessage} instance by extracting the payload from 
29       * <code>transportMessage</code>. Additional message properties will be taken from
30       * <code>previousMessage</code>.
31       */
32      MuleMessage create(Object transportMessage, MuleMessage previousMessage, String encoding)
33          throws Exception;
34  }