ch.software_atelier.simpleflex.docs.impl

Class FileDoc

java.lang.Object

ch.software_atelier.simpleflex.docs.WebDoc

ch.software_atelier.simpleflex.docs.impl.FileDoc

public class FileDoc
extends WebDoc

Represents a File

Nested Class Summary

Nested classes/interfaces inherited from class ch.software_atelier.simpleflex.docs.WebDoc

WebDoc.HTTPCode

Field Summary

Fields inherited from class ch.software_atelier.simpleflex.docs.WebDoc

DATA_BYTE, DATA_STREAM

Constructor Summary

Constructors

Constructor and Description
FileDoc(File file) It simply creates a WebDoc-Object that serves the specified File.
FileDoc(File file, boolean delete) It simply creates a WebDoc-Object that serves the specified File.
FileDoc(Request req, File baseDir)

Method Summary

Modifier and Type	Method and Description
byte[]	byteData() If you want to return the documents data as a byte[], you have to do that here.
void	close() This method is called after the transmission.
String	dataType() Specifies the Type of served data.
static WebDoc	fileByReq(Request req, File baseDir, String appName)
String	mime() This method has to return the MIME-Type of the Document.
String	name() This method has to return the FileName of the Document.
long	size() This method has to return the size of the Document in bytes.
InputStream	streamData() If you want to return the documents data as a Stream, you have to do that here.

Methods inherited from class ch.software_atelier.simpleflex.docs.WebDoc

getHeaders, getHttpCode, setHTTPCode

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDoc

public FileDoc(File file)
        throws FileDocException

It simply creates a WebDoc-Object that serves the specified File.

Parameters:

file - the File, that must be sent

Throws:

FileDocException - if the File does not exists.

FileDoc

public FileDoc(File file,
               boolean delete)
        throws FileDocException

It simply creates a WebDoc-Object that serves the specified File.

Parameters:

file - the File, that must be sent

delete - delete after dent

Throws:

FileDocException - if the File does not exists.

FileDoc

public FileDoc(Request req,
               File baseDir)
        throws FileDocException

Throws:

FileDocException

Method Detail

fileByReq

public static WebDoc fileByReq(Request req,
                               File baseDir,
                               String appName)
                        throws FileDocException

Throws:

FileDocException

size

public long size()

Description copied from class: WebDoc

This method has to return the size of the Document in bytes.

Specified by:

size in class WebDoc

Returns:

mime

public String mime()

Description copied from class: WebDoc

This method has to return the MIME-Type of the Document. Example: text/plain. You can also use the static Method Utils.getMime(String ext) to get the MIME-Type of a File-Extension.

Specified by:

mime in class WebDoc

Returns:

name

public String name()

Description copied from class: WebDoc

This method has to return the FileName of the Document.

Specified by:

name in class WebDoc

Returns:

byteData

public byte[] byteData()

Description copied from class: WebDoc

If you want to return the documents data as a byte[], you have to do that here. Be sure, that the method dataType() returns WebDoc.DATA_BYTE! Else just return null or something else. If the method dataType() does not return WebDoc.DATA_BYTE, this method will never be called.

Specified by:

byteData in class WebDoc

Returns:

streamData

public InputStream streamData()

Description copied from class: WebDoc

If you want to return the documents data as a Stream, you have to do that here. Be sure, that the method dataType() returns WebDoc.DATA_STREAM! Else just return null or something else. If the method dataType() does not return WebDoc.DATA_STREAM, this method will never be called. The Stream will be closed by the Server-App so you have nothing to do with that.

Specified by:

streamData in class WebDoc

Returns:

dataType

public String dataType()

Description copied from class: WebDoc

Specifies the Type of served data. Look at streamData() and/or byteData()

Specified by:

dataType in class WebDoc

Returns:

close

public void close()

Description copied from class: WebDoc

This method is called after the transmission. It can be used to cleanup something.

Specified by:

close in class WebDoc