001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.io;
029
030import java.io.IOException;
031
032import org.apache.http.HttpException;
033import org.apache.http.HttpMessage;
034
035/**
036 * Abstract message writer intended to serialize HTTP messages to an arbitrary
037 * data sink.
038 *
039 * @since 4.0
040 */
041public interface HttpMessageWriter<T extends HttpMessage> {
042
043    /**
044     * Serializes an instance of {@link HttpMessage} to the underlying data
045     * sink.
046     *
047     * @param message HTTP message
048     * @throws IOException in case of an I/O error
049     * @throws HttpException in case of HTTP protocol violation
050     */
051    void write(T message)
052        throws IOException, HttpException;
053
054}