michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.impl.io;
michael@0: 
michael@0: import java.io.IOException;
michael@0: import java.util.Iterator;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.Header;
michael@0: import ch.boye.httpclientandroidlib.HttpException;
michael@0: import ch.boye.httpclientandroidlib.HttpMessage;
michael@0: import ch.boye.httpclientandroidlib.io.HttpMessageWriter;
michael@0: import ch.boye.httpclientandroidlib.io.SessionOutputBuffer;
michael@0: import ch.boye.httpclientandroidlib.message.LineFormatter;
michael@0: import ch.boye.httpclientandroidlib.message.BasicLineFormatter;
michael@0: import ch.boye.httpclientandroidlib.params.HttpParams;
michael@0: import ch.boye.httpclientandroidlib.util.CharArrayBuffer;
michael@0: 
michael@0: /**
michael@0:  * Abstract base class for HTTP message writers that serialize output to
michael@0:  * an instance of {@link SessionOutputBuffer}.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public abstract class AbstractMessageWriter implements HttpMessageWriter {
michael@0: 
michael@0:     protected final SessionOutputBuffer sessionBuffer;
michael@0:     protected final CharArrayBuffer lineBuf;
michael@0:     protected final LineFormatter lineFormatter;
michael@0: 
michael@0:     /**
michael@0:      * Creates an instance of AbstractMessageWriter.
michael@0:      *
michael@0:      * @param buffer the session output buffer.
michael@0:      * @param formatter the line formatter.
michael@0:      * @param params HTTP parameters.
michael@0:      */
michael@0:     public AbstractMessageWriter(final SessionOutputBuffer buffer,
michael@0:                                  final LineFormatter formatter,
michael@0:                                  final HttpParams params) {
michael@0:         super();
michael@0:         if (buffer == null) {
michael@0:             throw new IllegalArgumentException("Session input buffer may not be null");
michael@0:         }
michael@0:         this.sessionBuffer = buffer;
michael@0:         this.lineBuf = new CharArrayBuffer(128);
michael@0:         this.lineFormatter = (formatter != null) ?
michael@0:             formatter : BasicLineFormatter.DEFAULT;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Subclasses must override this method to write out the first header line
michael@0:      * based on the {@link HttpMessage} passed as a parameter.
michael@0:      *
michael@0:      * @param message the message whose first line is to be written out.
michael@0:      * @throws IOException in case of an I/O error.
michael@0:      */
michael@0:     protected abstract void writeHeadLine(HttpMessage message) throws IOException;
michael@0: 
michael@0:     public void write(
michael@0:             final HttpMessage message) throws IOException, HttpException {
michael@0:         if (message == null) {
michael@0:             throw new IllegalArgumentException("HTTP message may not be null");
michael@0:         }
michael@0:         writeHeadLine(message);
michael@0:         for (Iterator it = message.headerIterator(); it.hasNext(); ) {
michael@0:             Header header = (Header) it.next();
michael@0:             this.sessionBuffer.writeLine
michael@0:                 (lineFormatter.formatHeader(this.lineBuf, header));
michael@0:         }
michael@0:         this.lineBuf.clear();
michael@0:         this.sessionBuffer.writeLine(this.lineBuf);
michael@0:     }
michael@0: 
michael@0: }