View Javadoc

1   /*
2    * $Id: OutputHandler.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.MuleEvent;
14  
15  import java.io.IOException;
16  import java.io.OutputStream;
17  
18  /**
19   * The OutputHandler is a strategy class that is used to defer the writing of the message payload 
20   * until there is a stream available to write it to.
21   */
22  public interface OutputHandler
23  {
24      /**
25       * Write the event payload to the stream. Depending on the underlying transport,
26       * attachements and message properties may be written to the stream here too.
27       * 
28       * @param event the current event
29       * @param out the output stream to write to
30       * @throws IOException in case of error
31       */
32      void write(MuleEvent event, OutputStream out) throws IOException;
33  }