1   /*
    2    *  Licensed to the Apache Software Foundation (ASF) under one
    3    *  or more contributor license agreements.  See the NOTICE file
    4    *  distributed with this work for additional information
    5    *  regarding copyright ownership.  The ASF licenses this file
    6    *  to you under the Apache License, Version 2.0 (the
    7    *  "License"); you may not use this file except in compliance
    8    *  with the License.  You may obtain a copy of the License at
    9    *
   10    *   http://www.apache.org/licenses/LICENSE-2.0
   11    *
   12    *  Unless required by applicable law or agreed to in writing,
   13    *  software distributed under the License is distributed on an
   14    *   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   15    *  KIND, either express or implied.  See the License for the
   16    *  specific language governing permissions and limitations
   17    *  under the License.
   18    */
   19   package org.apache.synapse.format;
   20   
   21   import javax.activation.DataSource;
   22   
   23   import org.apache.axiom.om.OMOutputFormat;
   24   import org.apache.axis2.AxisFault;
   25   import org.apache.axis2.context.MessageContext;
   26   import org.apache.axis2.transport.MessageFormatter;
   27   
   28   /**
   29    * Message formatter with extended capabilities.
   30    * This interface adds new methods to the {@link MessageFormatter}
   31    * interface, allowing transport to optimize data transfers.
   32    */
   33   public interface MessageFormatterEx extends MessageFormatter {
   34       /**
   35        * Get the formatted message as a {@link DataSource} object.
   36        * 
   37        * @param messageContext
   38        * @param format
   39        * @param soapAction
   40        * @return
   41        * @throws AxisFault
   42        */
   43       DataSource getDataSource(MessageContext messageContext, OMOutputFormat format, String soapAction) throws AxisFault;
   44   }