org.apache.commons.httpclient.methods

Interface RequestEntity

Known Implementing Classes:
ByteArrayRequestEntity, InputStreamRequestEntity, MultipartRequestEntity, StringRequestEntity

public interface RequestEntity

Since:
3.0

Method Summary

long
getContentLength()
Gets the request entity's length.
String
getContentType()
Gets the entity's content type.
boolean
isRepeatable()
Tests if writeRequest(OutputStream) can be called more than once.
void
writeRequest(OutputStream out)
Writes the request entity to the given stream.

Method Details

getContentLength

public long getContentLength()
Returns:
a non-negative value when content length is known or a negative value when content length is not known

getContentType

public String getContentType()
Gets the entity's content type. This content type will be used as the value for the "Content-Type" header.
Returns:
the entity's content type

isRepeatable

public boolean isRepeatable()
Tests if writeRequest(OutputStream) can be called more than once.
Returns:
true if the entity can be written to OutputStream more than once, false otherwise.

writeRequest

public void writeRequest(OutputStream out)
            throws IOException
Writes the request entity to the given stream.
Parameters:
out -

Copyright (c) 1999-2005 - Apache Software Foundation