oracle.cabo.servlet.util
Class FileDownloadRenderer

java.lang.Object
  |
  +--oracle.cabo.servlet.util.FileDownloadRenderer

All Implemented Interfaces:

PageRenderer

public class FileDownloadRenderer

extends java.lang.Object

implements PageRenderer

FileDownloadRenderer supports streaming binary and text files back to a user for a given page. Clients who will be repeatedly sending large files to users should avoid using this renderer and instead have a real FTP site, since the scalability of a site heavily relying on this class would be limited.

Because FileDownloadRenderers will close their input stream or reader once finished, they cannot be reused, and must be recreated with each request.

Constructor Summary

FileDownloadRenderer(java.io.File file, java.lang.String mimeType)
Creates a FileDownloadRenderer.

FileDownloadRenderer(java.lang.String fileName, java.io.InputStream stream, java.lang.String mimeType)
Creates a FileDownloadRenderer for a given input stream.

FileDownloadRenderer(java.lang.String fileName, java.io.InputStream stream, java.lang.String mimeType, int size)
Creates a FileDownloadRenderer for a given input stream with known size.

FileDownloadRenderer(java.lang.String fileName, java.io.Reader reader, java.lang.String mimeType)
Creates a FileDownloadRenderer for a given reader.

Method Summary

void	renderPage(BajaContext context, Page page) Renders a page.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDownloadRenderer

public FileDownloadRenderer(java.io.File file,
                            java.lang.String mimeType)

Creates a FileDownloadRenderer. The mimeType should include the character set encoding used, if applicable.

Parameters:

file - an existing file

mimeType - the MIME type of the file

FileDownloadRenderer

public FileDownloadRenderer(java.lang.String fileName,
                            java.io.InputStream stream,
                            java.lang.String mimeType)

Creates a FileDownloadRenderer for a given input stream. The stream will be closed once the page has rendered.

Parameters:

fileName - the intended name of the file

stream - an open input stream

mimeType - the MIME type of the file

FileDownloadRenderer

public FileDownloadRenderer(java.lang.String fileName,
                            java.io.InputStream stream,
                            java.lang.String mimeType,
                            int size)

Creates a FileDownloadRenderer for a given input stream with known size. The stream will be closed once the page has rendered.

Parameters:

fileName - the intended name of the file

stream - an open input stream

mimeType - the MIME type of the file

size - the known size of the file, in bytes

FileDownloadRenderer

public FileDownloadRenderer(java.lang.String fileName,
                            java.io.Reader reader,
                            java.lang.String mimeType)

Creates a FileDownloadRenderer for a given reader. The mimeType should include the character set encoding used, if applicable. The reader will be closed once the page has rendered.

Parameters:

fileName - the intended name of the file

reader - an open reader

mimeType - the MIME type of the file, including character encoding

Method Detail

renderPage

public void renderPage(BajaContext context,
                       Page page)
                throws java.io.IOException,
                       javax.servlet.ServletException

Renders a page.

Specified by:

renderPage in interface PageRenderer

Parameters:

context - the BajaContext

page - the page returned from handleRequest