net.officefloor.plugin.web.http.resource

Interface HttpFileDescription

All Known Implementing Classes:

AbstractHttpFileDescription

public interface HttpFileDescription

Allows providing a description of a HttpFile.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
ByteBuffer	getContents() Obtains the contents of the HttpFile.
HttpResource	getResource() Obtains the HttpResource for details of the HttpFile.
void	setContentEncoding(String encoding) This is to be invoked by the HttpFileDescriber to describe the Content-Encoding of the HttpFile.
void	setContentType(String type, Charset charset) This is to be invoked by the HttpFileDescriber to describe the Content-Type of the HttpFile.

Method Detail

getResource

HttpResource getResource()

Obtains the HttpResource for details of the HttpFile.

This allows, for example, mapping file extensions to descriptions (from the path).

Returns:

HttpResource of the HttpFile.

getContents

ByteBuffer getContents()

Obtains the contents of the HttpFile.

This allows interrogating the contents to determine/guess the description.

Returns:

Contents of the HttpFile.

setContentEncoding

void setContentEncoding(String encoding)

This is to be invoked by the HttpFileDescriber to describe the Content-Encoding of the HttpFile.

Parameters:

encoding - Content-Encoding of the HttpFile.

setContentType

void setContentType(String type,
                    Charset charset)

This is to be invoked by the HttpFileDescriber to describe the Content-Type of the HttpFile.

Parameters:

type - Content-Type of the HttpFile.

charset - Charset or null if content is not text.