org.dmfs.httpclientinterfaces.requestutils

Class BufferedRequestEntity

java.lang.Object

org.dmfs.httpclientinterfaces.requestutils.BufferedRequestEntity

All Implemented Interfaces:

HttpRequestEntity

public final class BufferedRequestEntity
extends java.lang.Object
implements HttpRequestEntity

A buffered request entity wrapper. It buffers the content of another HttpRequestEntity, if necessary, to determine the content length before sending it to the client. Implementations can use this to avoid chunked encoding if the server doesn't support it.

Author:

Marten Gajda

Constructor Summary

Constructors

Constructor and Description
BufferedRequestEntity(HttpRequestEntity bufferedEntity)
BufferedRequestEntity(HttpRequestEntity bufferedEntity, int maxBufferSize)

Method Summary

Modifier and Type	Method and Description
long	contentLength() Returns the length of the content or a negative number if it's not known.
ContentType	contentType() Returns the content type of the entity if known.
void	writeContent(java.io.OutputStream out) Writes the content to the given OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedRequestEntity

public BufferedRequestEntity(HttpRequestEntity bufferedEntity)

BufferedRequestEntity

public BufferedRequestEntity(HttpRequestEntity bufferedEntity,
                             int maxBufferSize)

Method Detail

contentType

public ContentType contentType()

Description copied from interface: HttpRequestEntity

Returns the content type of the entity if known.

Specified by:

contentType in interface HttpRequestEntity

Returns:

The content type or null if no content type is applicable (like when the entity is empty).

contentLength

public long contentLength()
                   throws java.io.IOException

Description copied from interface: HttpRequestEntity

Returns the length of the content or a negative number if it's not known.

Specified by:

contentLength in interface HttpRequestEntity

Returns:

The content length or a negative number.

Throws:

java.io.IOException

writeContent

public void writeContent(java.io.OutputStream out)
                  throws java.io.IOException

Description copied from interface: HttpRequestEntity

Writes the content to the given OutputStream. Note that the stream is property of the caller and must not be closed by this method.

Specified by:

writeContent in interface HttpRequestEntity

Parameters:

out - The OutputStream to write to.

Throws:

java.io.IOException