org.codehaus.httpcache4j.payload

Class MD5CaculcatingPayload

java.lang.Object

org.codehaus.httpcache4j.payload.MD5CaculcatingPayload

All Implemented Interfaces:

Payload

public class MD5CaculcatingPayload
extends Object
implements Payload

Calculates the MD5 of the payload. Copies the payload into a byte array if the data is small enough, changes to a backing file if the content is large.

Author:

Erlend Hamnaberg

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getInputStream() Returns the input stream of the payload.
String	getMD5()
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.
static MD5CaculcatingPayload	payloadFor(Payload p)

Methods inherited from class java.lang.Object

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

Method Detail

getMD5

public String getMD5()

getMimeType

public MIMEType getMimeType()

Description copied from interface: Payload

Return the mime-type of the payload.

Specified by:

getMimeType in interface Payload

Returns:

the mime-type

getInputStream

public InputStream getInputStream()

Description copied from interface: Payload

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

Specified by:

getInputStream in interface Payload

Returns:

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

length

public long length()

Description copied from interface: Payload

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.

Specified by:

length in interface Payload

Returns:

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

isAvailable

public boolean isAvailable()

Description copied from interface: Payload

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

Specified by:

isAvailable in interface Payload

Returns:

true if the payload is available. false if not.

payloadFor

public static MD5CaculcatingPayload payloadFor(Payload p)