public class

ContentLengthInputStream

extends InputStream
java.lang.Object
   ↳ java.io.InputStream
     ↳ org.apache.http.impl.io.ContentLengthInputStream

Class Overview

Input stream that cuts off after a defined number of bytes. This class is used to receive 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 MAX_VALUE long.

Note that this class NEVER closes the underlying stream, even when close gets called. Instead, it will read until the "end" of its limit on close, which allows for the seamless execution of subsequent HTTP 1.1 requests, while not requiring the client to remember to read the entire contents of the response.

Summary

Public Constructors
ContentLengthInputStream(SessionInputBuffer in, long contentLength)
Wraps a session input buffer and cuts off output after a defined number of bytes.
Public Methods
int available()
void close()

Reads until the end of the known length of content.

int read(byte[] b)
Read more bytes from the stream.
int read()
Read the next byte from the stream
int read(byte[] b, int off, int len)
Does standard read(byte[], int, int) behavior, but also notifies the watcher when the contents have been consumed.
long skip(long n)
Skips and discards a number of bytes from the input stream.
[Expand]
Inherited Methods
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

public ContentLengthInputStream (SessionInputBuffer in, long contentLength)

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

Parameters
in The session input buffer
contentLength The maximum number of bytes that can be read from the stream. Subsequent read operations will return -1.

Public Methods

public int available ()

Throws
IOException

public void close ()

Reads until the end of the known length of content.

Does not close the underlying socket input, but instead leaves it primed to parse the next response.

Throws
IOException If an IO problem occurs.

public int read (byte[] b)

Read more bytes from the stream.

Parameters
b The byte array to put the new data in.
Returns
  • The number of bytes read into the buffer.
Throws
IOException If an IO problem occurs
See Also

public int read ()

Read the next byte from the stream

Returns
  • The next byte or -1 if the end of stream has been reached.
Throws
IOException If an IO problem occurs
See Also

public int read (byte[] b, int off, int len)

Does standard read(byte[], int, int) behavior, but also notifies the watcher when the contents have been consumed.

Parameters
b The byte array to fill.
off Start filling at this position.
len The number of bytes to attempt to read.
Returns
  • The number of bytes read, or -1 if the end of content has been reached.
Throws
IOException Should an error occur on the wrapped stream.

public long skip (long n)

Skips and discards a number of bytes from the input stream.

Parameters
n The number of bytes to skip.
Returns
  • The actual number of bytes skipped. <= 0 if no bytes are skipped.
Throws
IOException If an error occurs while skipping bytes.
See Also