Servertec FileServlet
Content
Introduction
Release Notes
Features
FAQs
Requirements
Installation
Add-ons
How To
Change Log
Future Plans
Knowledge Base
Documentation
Conventions
Command Line
Administrator
Localization
Programming
Security
Performance
Deployment
Java API
Servlet API
CGI
SSI
Servlets
AdminServlet
CgiServlet
ClusterProxy
ClusterRedirector
CommandServlet
FileServlet
InvokerServlet
MessageServlet
RedirectServlet
ServletTagServlet
SSIncludeServlet
StatusServlet

Config Files
Log Files
Classes
Directory Tree
Samples
Legal
Contact Us

 

FileServlet provides access to local file system.

Parameters

cache_size The amount of memory in megabytes to use to cache files.

4 is the default value.

Must be 1 or more megabytes in size. Use 0 to disable the cache.

A file cache may improve performance.

default_folder_icon The relative URI of the image to use for folders when listing directories.

/images/folder.gif is the default.

Used when directory_access is set to y and when display_icons is set to y.

default_folder_type The short text description to use for folders when listing directories.

File Folder is the default.

Used when directory_access is set to y.

directory_access Whether to allow directories to be displayed.

n is the default value.

Setting this value to y is potentially a security hole.

display_icons Whether to display icon images in directory listings.

y to display icons in directory listings and n to only display text in directory listings.

n is the default value.

Setting this value to y may have a negative impact on performance.

Used when directory_access is set to y.

files Comma delimited list of paths to files to preload into the cache.

The size of file cache must be large enough to contain all of the files.

Preloading commonly used files into the cache may improve performance.

include_hidden Whether to include in directory listing files and directories prefixed with period.

y specifies that files and directories starting with a period should be included in directory listings and n specified that they should not be included in directory listings.

n is the default.

Used when directory_access is set to y.

parent_folder_icon The relative URI of the image to use for parent folder when listing directories.

/images/parent.gif is the default.

Used when directory_access is set to y and when display_icons is set to y.

read_buffer_size The size in bytes of the buffer used to read files from the file system.

The value output_buffer_size as defined in iws_dir/config/iws.ini is the default value.

Must be 512 bytes or more.

-1 to use the default value.

A value that is too small or too large may have a negative impact on performance.

sort Whether to directory listing should be sorted by specified field.

y is used to sort directory listings and n is used generated directory listings with files ordered as they appear in the file system.

y is the default.

Setting this value to y may have a negative impact on performance.

Used when directory_access is set to y.

sort_descending Whether to sort the specified directory listing in descending or ascending order.

y sort descending and n sort ascending.

n is the default.

Used when directory_access is set to y and sort is set to y.

sort_field_name The name of the field to sort directory listings.

Name, Size, Type and Modified can be used.

Name is the default.

Used when directory_access is set to y and sort is set to y.

sort_ignore_case Whether to ignore case when sorting directory listings.

y ignore case and n do not ignore case.

y is the default.

Used when directory_access is set to y and sort is set to y.

use_redirect Whether to do a redirect to the default file or send the default file as the response to the request.

y to perform a redirect to the default file and n to send the default file as the response.

y is the default.

Setting this value to y may have a negative impact on performance.

Setting this value to n may break relative links in default pages.

Aliases

Alias: /
Type: Servlet
Resource: FileServlet

Servlets

Alias: FileServlet
Class File: stec.iws.FileServlet
Parameters: cache_size=8

Notes

Normally defined as a Servlet aliased as /.

FileServlet uses Root Directory defined in Virtual Hosts Administrator and Content Negotiation, Send Vary, Default Content Type, Content Types, Default Language, Default Charset, Default Content Encoding and Content Encodings defined in Server Administrator.

FileServlet first tried to use local .directory.html template using content negotiation rules. If a local template is not found then FileServlet uses the default template iws_dir/templates/directory.html. FileServlet also uses iws_dir/templates/directory_item.tf html template when generating listings of each item found in the directory.

Icon images used in directory listings are normally located in iws_dir/wwwroot/images directory.

File icon images used in directory listings are defined in iws_dir/config/mimetypes.ini configuration file and and folder icon images are defined in default_folder_icon, parent_folder_icon initialization parameters.

 top of page
Copyright © 1998-2005 Servertec. All rights reserved.
Privacy Statement.
Last Modified: Sun Sep 04 14:56:49 EDT 2005