View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.io;
29  
30  import java.io.IOException;
31  
32  import org.apache.http.HttpException;
33  import org.apache.http.HttpMessage;
34  
35  /**
36   * Abstract message writer intended to serialize HTTP messages to an arbitrary
37   * data sink.
38   *
39   * @since 4.0
40   */
41  public interface HttpMessageWriter<T extends HttpMessage> {
42  
43      /**
44       * Serializes an instance of {@link HttpMessage} to the underlying data
45       * sink.
46       *
47       * @param message
48       * @throws IOException in case of an I/O error
49       * @throws HttpException in case of HTTP protocol violation
50       */
51      void write(T message)
52          throws IOException, HttpException;
53  
54  }