Package net.lenni0451.commons.httpclient.content

Class StreamedHttpContent

java.lang.Object

net.lenni0451.commons.httpclient.content.HttpContent

net.lenni0451.commons.httpclient.content.StreamedHttpContent

public class StreamedHttpContent
extends HttpContent

Represents a streamed http content which is not fully loaded into memory.
It requires special handling in the executor to support this type of content.
It is fully backwards compatible if the executor does not support this feature by reading the entire stream into memory.
All built-in executors support this type of content.

Field Summary

Fields inherited from class net.lenni0451.commons.httpclient.content.HttpContent

content

Constructor Summary

Constructors

Constructor	Description
StreamedHttpContent(ContentType contentType, java.io.InputStream inputStream, int contentLength)

Method Summary

Modifier and Type	Method	Description
protected byte[]	compute()
int	getBufferSize()
int	getContentLength()
java.io.InputStream	getInputStream()
StreamedHttpContent	setBufferSize(int bufferSize)	Set the buffer size for reading the stream. This option may be ignored depending on the executor implementation.
static StreamedHttpContent	wrap(HttpContent other)	Wrap the given http content into a streamed content. This will read the entire content into memory.

Methods inherited from class net.lenni0451.commons.httpclient.content.HttpContent

bytes, bytes, file, form, form, getAsBytes, getAsString, getAsString, getContentType, multiPartForm, streamed, string, string

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamedHttpContent

public StreamedHttpContent(ContentType contentType,
                           java.io.InputStream inputStream,
                           int contentLength)

Method Detail

wrap

public static StreamedHttpContent wrap(HttpContent other)
                                throws java.io.IOException

Wrap the given http content into a streamed content.
This will read the entire content into memory.

Parameters:

other - The content to wrap

Returns:

The wrapped content

Throws:

java.io.IOException - If an error occurs reading the content

See Also:

HttpRequestUtils.readFromStream(InputStream)

getInputStream

public java.io.InputStream getInputStream()

Returns:

The input stream

getBufferSize

public int getBufferSize()

Returns:

The buffer size for reading the stream

setBufferSize

public StreamedHttpContent setBufferSize(int bufferSize)

Set the buffer size for reading the stream.
This option may be ignored depending on the executor implementation.

Parameters:

bufferSize - The buffer size

Returns:

This instance for chaining

getContentLength

public int getContentLength()

Specified by:

getContentLength in class HttpContent

Returns:

The content length

compute

@Nonnull
protected byte[] compute()
                  throws java.io.IOException

Specified by:

compute in class HttpContent

Returns:

The content

Throws:

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