Package org.apache.hc.core5.http.impl.io

Class ContentLengthOutputStream

java.lang.Object

java.io.OutputStream

org.apache.hc.core5.http.impl.io.ContentLengthOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ContentLengthOutputStream
extends 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	Description
private final SessionOutputBuffer	buffer
private boolean	closed	True if the stream is closed.
private final long	contentLength	The maximum number of bytes that can be written the stream.
private final OutputStream	outputStream
private long	total	Total bytes written

Constructor Summary

Constructors

Constructor	Description
ContentLengthOutputStream(SessionOutputBuffer buffer, OutputStream outputStream, long contentLength)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Finishes writing to the underlying stream, but does NOT close the underlying stream.
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 Details

buffer

private final SessionOutputBuffer buffer

outputStream

private final OutputStream outputStream

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 Details

ContentLengthOutputStream

public ContentLengthOutputStream(SessionOutputBuffer buffer,
 OutputStream outputStream,
 long contentLength)

Default constructor.

Parameters:

buffer - Session output buffer

outputStream - Output stream

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

Since:

4.0

Method Details

close

public void close()
           throws IOException

Finishes writing to the underlying stream, but does NOT close the underlying stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException - If an I/O problem occurs.

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException