org.codehaus.httpcache4j.payload

Interface Payload

All Known Implementing Classes:

ByteArrayPayload, ClosedInputStreamPayload, FilePayload, FormDataPayload, InputStreamPayload, MD5CaculcatingPayload, StringPayload

public interface Payload

Represents a HTTP payload. may be either a request payload or a response payload.

Author:

Erlend Hamnaberg

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getInputStream() Returns the input stream of the payload.
MIMEType	getMimeType() Return the mime-type of the payload.
boolean	isAvailable() Returns true if the payload is available, IE.
long	length() Returns the length of the stream.

Method Detail

getMimeType

MIMEType getMimeType()

Return the mime-type of the payload.

Returns:

the mime-type

getInputStream

InputStream getInputStream()

Returns the input stream of the payload. This stream MUST be closed when you are done with it.

Returns:

the inputstream of the payload, may return null if the payload is not available.

length

long length()

Returns the length of the stream. If the payload is used in a HTTPResponse, this is the value of the Content-Length header. If the payload is used in a request, it can be set, or calculated based on the type.

Returns:

-1 if the length cannot be calculated or set. Otherwise the expected length of the stream.

isAvailable

boolean isAvailable()

Returns true if the payload is available, IE. If the stream can be read from.

Returns:

true if the payload is available. false if not.