home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/ChunkedOutputStream.java,v 1.10.2.1 2004/02/22 18:21:13 olegk Exp $
 * $Revision: 1.10.2.1 $
 * $Date: 2004/02/22 18:21:13 $
 *
 * ====================================================================
 *
 *  Copyright 2002-2004 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 * [Additional notices, if required by prior licensing conditions]
 *
 */

package org.apache.commons.httpclient;

import java.io.IOException;
import java.io.OutputStream;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * 

* Wrapper supporting the chunked transfer encoding. *

* * @author Remy Maucherat * @author Sean C. Sullivan * @author dIon Gillard * @author Oleg Kalnichevski * @author Mike Bowler * @version $Revision: 1.10.2.1 $ $Date: 2004/02/22 18:21:13 $ * * @see ChunkedInputStream * @since 2.0 * */ public class ChunkedOutputStream extends OutputStream { // ------------------------------------------------------- Static Variables /** "\r\n", as bytes. */ private static final byte CRLF[] = new byte[] {(byte) 13, (byte) 10}; /** End chunk */ private static final byte ENDCHUNK[] = CRLF; /** 0 */ private static final byte ZERO[] = new byte[] {(byte) '0'}; /** 1 */ private static final byte ONE[] = new byte[] {(byte) '1'}; /** Log object for this class. */ private static final Log LOG = LogFactory.getLog(ChunkedOutputStream.class); // ----------------------------------------------------- Instance Variables /** Has this stream been closed? */ private boolean closed = false; /** The underlying output stream to which we will write data */ private OutputStream stream = null; // ----------------------------------------------------------- Constructors /** * Construct an output stream wrapping the given stream. * The stream will not use chunking. * * @param stream wrapped output stream. Must be non-null. */ public ChunkedOutputStream(OutputStream stream) { if (stream == null) { throw new NullPointerException("stream parameter is null"); } this.stream = stream; } // --------------------------------------------------------- Public Methods /** * Writes a String to the client, without a carriage return * line feed (CRLF) character at the end. The platform default encoding is * used! * * @param s the String to send to the client. Must be non-null. * @throws IOException if an input or output exception occurred */ public void print(String s) throws IOException { LOG.trace("enter ChunckedOutputStream.print(String)"); if (s == null) { s = "null"; } write(HttpConstants.getBytes(s)); } /** * Writes a carriage return-line feed (CRLF) to the client. * * @throws IOException if an input or output exception occurred */ public void println() throws IOException { print("\r\n"); } /** * Writes a String to the client, * followed by a carriage return-line feed (CRLF). * * @param s the String to write to the client * @exception IOException if an input or output exception occurred */ public void println(String s) throws IOException { print(s); println(); } // -------------------------------------------- OutputStream Methods /** * Write the specified byte to our output stream. * * @param b The byte to be written * @throws IOException if an input/output error occurs * @throws IllegalStateException if stream already closed */ public void write (int b) throws IOException, IllegalStateException { if (closed) { throw new IllegalStateException("Output stream already closed"); } //FIXME: If using chunking, the chunks are ONE byte long! stream.write(ONE, 0, ONE.length); stream.write(CRLF, 0, CRLF.length); stream.write(b); stream.write(ENDCHUNK, 0, ENDCHUNK.length); LOG.debug("Writing chunk (length: 1)"); } /** * Write the specified byte array. * * @param b the byte array to write out * @param off the offset within b to start writing from * @param len the length of data within b to write * @throws IOException when errors occur writing output */ public void write (byte[] b, int off, int len) throws IOException { LOG.trace("enter ChunckedOutputStream.write(byte[], int, int)"); if (closed) { throw new IllegalStateException("Output stream already closed"); } byte chunkHeader[] = HttpConstants.getBytes ( Integer.toHexString(len) + "\r\n"); stream.write(chunkHeader, 0, chunkHeader.length); stream.write(b, off, len); stream.write(ENDCHUNK, 0, ENDCHUNK.length); if (LOG.isDebugEnabled()) { LOG.debug("Writing chunk (length: " + len + ")"); } } /** * Close this output stream, causing any buffered data to be flushed and * any further output data to throw an IOException. The underlying stream * is not closed! * * @throws IOException if an error occurs closing the stream */ public void writeClosingChunk() throws IOException { LOG.trace("enter ChunkedOutputStream.writeClosingChunk()"); if (!closed) { try { // Write the final chunk. stream.write(ZERO, 0, ZERO.length); stream.write(CRLF, 0, CRLF.length); stream.write(ENDCHUNK, 0, ENDCHUNK.length); LOG.debug("Writing closing chunk"); } catch (IOException e) { LOG.debug("Unexpected exception caught when closing " + "output stream", e); throw e; } finally { // regardless of what happens, mark the stream as closed. // if there are errors closing it, there's not much we can do // about it closed = true; } } } /** * Flushes the underlying stream. * @throws IOException If an IO problem occurs. */ public void flush() throws IOException { stream.flush(); } /** * Close this output stream, causing any buffered data to be flushed and * any further output data to throw an IOException. The underlying stream * is not closed! * * @throws IOException if an error occurs closing the stream */ public void close() throws IOException { LOG.trace("enter ChunkedOutputStream.close()"); writeClosingChunk(); super.close(); } }


my book on functional programming

 

new blog posts

 

Copyright 1998-2019 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.