fr.maxcom.http

Interface LocalSingleHttpServer.DataSource

All Known Implementing Classes:

LocalSingleHttpServer.FileDataSource

Enclosing class:

LocalSingleHttpServer

public static interface LocalSingleHttpServer.DataSource

A data provider. If the default implementation (FileDataSource) is not enough, you can design your own data provider object and give it to the server with the setDataSource() method.

Method Summary

Modifier and Type	Method and Description
long	getContentLength() Returns the length of data to deliver in the HTTP response entity, if known.
long	getContentSize() Returns the total length of the resource content, if known.
String	getContentType() Returns the content type of the resource, if known.
InputStream	getInputStream() Returns a content stream of the resource.
long	getOffset() Returns the offset in the resource flow.
String	getUriString() Returns the URI of the data source.
boolean	isExisting() Tests whether the resource exists.
boolean	isPartial() Tells whether the content to be delivered will be partial.
boolean	isReadable() Tests whether the resource can be read.
void	setCipher(Cipher cipher) Sets the Cipher to use if the stream has to be decrypted.
void	setCipherFactory(LocalSingleHttpServer.CipherFactory cipherFactory) Sets the factory instance, able to deliver ciphers when needed.
void	setSource(URI uri, long offset) Sets the properties of the data source.

Method Detail

setCipher

void setCipher(Cipher cipher)

Sets the Cipher to use if the stream has to be decrypted. The information may also be set through LocalSingleHttpServer.setCipher(Cipher).

Parameters:

cipher - The cipher needed to decrypt the stream.

setCipherFactory

void setCipherFactory(LocalSingleHttpServer.CipherFactory cipherFactory)

Sets the factory instance, able to deliver ciphers when needed. The information may also be set through LocalSingleHttpServer.setCipherFactory(CipherFactory).

Parameters:

cipherFactory - The factory to deliver ciphers on demand.

setSource

void setSource(URI uri,
               long offset)

Sets the properties of the data source.

Parameters:

uri - The URI as provided in the HTTP request line.

offset - The offset provided in a Range request header, or 0 by default.

getUriString

String getUriString()

Returns the URI of the data source. Mainly designed for the build of reporting messages.

Returns:

The string form of the URI, or null if called before setSource() by mistake.

isExisting

boolean isExisting()

Tests whether the resource exists.

Returns:

true if and only if the resource really exists.

isReadable

boolean isReadable()

Tests whether the resource can be read.

Returns:

true if and only if the resource can be accessed for reading.

getInputStream

InputStream getInputStream()
                    throws IOException

Returns a content stream of the resource.

Returns:

A content stream.

Throws:

IOException - If the stream can not be created or skipped, or if some other I/O error occurs.

isPartial

boolean isPartial()

Tells whether the content to be delivered will be partial. This should be the case when a non zero offset is set.

Returns:

true if the content to deliver is only a part of the full resource.

getContentSize

long getContentSize()

Returns the total length of the resource content, if known. This piece of information is useful to deliver partial content, with a Content-Range header.

Returns:

A number of bytes, or a negative number if unknown.

getOffset

long getOffset()

Returns the offset in the resource flow.

Returns:

The number of first bytes of data to skip before to stream the content.

getContentLength

long getContentLength()

Returns the length of data to deliver in the HTTP response entity, if known.

Returns:

A number of bytes, or a negative number if unknown, of the content that will be delivered by the getInputStream() method.

getContentType

String getContentType()

Returns the content type of the resource, if known.

Returns:

The content type, or null if the type is unknown.