FileMarshaler


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.servicemix.components.util;
18  
19  import javax.jbi.JBIException;
20  import javax.jbi.messaging.MessageExchange;
21  import javax.jbi.messaging.MessagingException;
22  import javax.jbi.messaging.NormalizedMessage;
23  
24  import java.io.IOException  ;
25  import java.io.InputStream  ;
26  import java.io.OutputStream  ;
27  
28  /**
29   * A pluggable strategy for turning a file or URL input source into
30   * a normalized message.
31   *
32   * @version $Revision: 426415 $
33   */
34  public interface FileMarshaler {
35  
36      /**
37       * Converts the file stream to a normalized message.
38       *
39       * @param exchange the message exchange
40       * @param message  the message to populate
41       * @param in       the input stream
42       * @param name     the name of the file, URI or URL
43       */
44      void readMessage(MessageExchange exchange, NormalizedMessage message, InputStream   in, String   path) throws IOException  , JBIException;
45  
46      /**
47       * Creates a output file name for the given exchange when reading an inbound
48       * message.
49       *
50       * @param exchange the inbound message exchange
51       * @param message the inbound message
52       * @return the file name or null if a file name could not be found or calculated
53       */
54      String   getOutputName(MessageExchange exchange, NormalizedMessage message) throws MessagingException;
55  
56      /**
57       * Writes the inbound message to the destination stream of the given name
58       *
59       * @param exchange the inbound message exchange
60       * @param message the inbound message
61       * @param out the output stream to write to
62       * @param path
63       */ 
64      void writeMessage(MessageExchange exchange, NormalizedMessage message, OutputStream   out, String   path) throws IOException  , JBIException;
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags