org.apache.http.impl.io

Class ContentLengthOutputStream

java.lang.Object

java.io.OutputStream

org.apache.http.impl.io.ContentLengthOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class ContentLengthOutputStream
extends java.io.OutputStream

Output stream that cuts off after a defined number of bytes. This class is used to send content of HTTP messages where the end of the content entity is determined by the value of the Content-Length header. Entities transferred using this stream can be maximum Long.MAX_VALUE long.

Note that this class NEVER closes the underlying stream, even when close gets called. Instead, the stream will be marked as closed and no further output will be permitted.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	closed True if the stream is closed.
private long	contentLength The maximum number of bytes that can be written the stream.
private SessionOutputBuffer	out Wrapped session output buffer.
private long	total Total bytes written

Constructor Summary

Constructors

Constructor and Description
ContentLengthOutputStream(SessionOutputBuffer out, long contentLength) Wraps a session output buffer and cuts off output after a defined number of bytes.

Method Summary

Modifier and Type	Method and Description
void	close() Does not close the underlying socket output.
void	flush()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

out

private final SessionOutputBuffer out

Wrapped session output buffer.

contentLength

private final long contentLength

The maximum number of bytes that can be written the stream. Subsequent write operations will be ignored.

total

private long total

Total bytes written

closed

private boolean closed

True if the stream is closed.

Constructor Detail

ContentLengthOutputStream

public ContentLengthOutputStream(SessionOutputBuffer out,
                                 long contentLength)

Wraps a session output buffer and cuts off output after a defined number of bytes.

Parameters:

out - The session output buffer

contentLength - The maximum number of bytes that can be written to the stream. Subsequent write operations will be ignored.

Since:

4.0

Method Detail

close

public void close()
           throws java.io.IOException

Does not close the underlying socket output.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - If an I/O problem occurs.

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException