org.dmfs.httpclientinterfaces

Interface HttpRequestEntity

All Known Implementing Classes:

BufferedRequestEntity, EmptyHttpRequestEntity

public interface HttpRequestEntity

Defines an interface of an HTTP message request body entity.

Author:

Marten Gajda

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.

Method Detail

contentType

ContentType contentType()

Returns the content type of the entity if known.

Returns:

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

contentLength

long contentLength()
            throws java.io.IOException

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

Returns:

The content length or a negative number.

Throws:

java.io.IOException

writeContent

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

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

Parameters:

out - The OutputStream to write to.

Throws:

java.io.IOException