se.entra.phantom.server.http

Class DirectoryListingCGI

java.lang.Object

se.entra.phantom.server.http.DirectoryListingCGI

All Implemented Interfaces:

IIPToLocation, IncludeCgiPrintInterface

public class DirectoryListingCGI
extends Object
implements IncludeCgiPrintInterface

The DirectoryListingCGI class lists a directory of files as specified by the tag element DIR relative the server directory (not htdocs).

It also contains a static method that other CGI's may call to produce this directory listing depending e.g. of a client certificate that implies a private directory on the server for the particular client.

A typical document would look like:

 (html)
 (head)
 (meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1")
 (title)Directory listing(/title)
 (style)
 (!--
   td { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 60%; }
 --)
 (/style)
 (body)
 (h2)Directory (%@include cgi="DIRLIST" dirname=1)(/h2)
 
 (table border cellspacing=1 cellpadding=1)
 
 (tr)
 (td bgcolor="#C0C0C0")(b)Name(/b)(/td)
 (td bgcolor="#C0C0C0" align="center")(b)Size(/b)(/td)
 (td bgcolor="#C0C0C0" align="center")(b)Date(/b)(/td)
 (/tr)
 
 (%@include cgi="DIRLIST"
    dir     ="."
    fileref ="/download.cgi"
    tr      ="(tr)"
    tdparent="(td)(pdir)  "
    tddir   ="(td)(dir)  "
    tdfile  ="(td)(file)  "
    tdsize  ="(td align='right')"
    tddate  ="(td)")
 
 (/table)
 
 (/body)
 (/html)
 

See Also:

FileDownloadCGI

Constructor Summary

Constructors

Constructor and Description
DirectoryListingCGI()

Method Summary

Modifier and Type	Method and Description
static void	listDirectory(HttpSession session, Element element, String dir, PrintWriter out) Prints the directory listing to the print writer.
void	performAction(HttpSession session, HttpResource resource, Element element, PrintWriter out) Prints the directory listing from the base directory as specified by the DIR element.

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.entra.phantom.server.http.IIPToLocation

formatIPResult, formatIPResult, queryLocationInfo, queryLocationInfo, queryLocationInfo

Constructor Detail

DirectoryListingCGI

public DirectoryListingCGI()

Method Detail

performAction

public void performAction(HttpSession session,
                          HttpResource resource,
                          Element element,
                          PrintWriter out)
                   throws IOException

Prints the directory listing from the base directory as specified by the DIR element. If the current document contains additional directory information specified after the "?" of the URL, this will be appended to the directory specified by DIR.

If the element DIRNAME=1 is specified, the subdirectory name specified in the URL as parameter is returned, e.g. (h2)Directory (%@include cgi="DIRLIST" dirname=1)(/h2)

The following elements are used to build the table:

• dir - the root directory for the listing relative the server directory.
• fileref - the base hyperlink for downloading files, e.g. /download.cgi will produce (a href="/download.cgi?%2Fselectedfile.doc")selectedfile.doc(/a).
• tr - the tag for each line in the listing, e.g. (tr).
• tdParent - the tag for parent directory, e.g. (td)(img src="images/updir.gif" width=6 height=6 alt="Parent directory"). This text will preceed the name of the parent directory.
• tdDir - the tag for directories, e.g. (td)(img src="images/dir.gif" width=6 height=6 alt="Directory"). This text will preceed the name of the directory.
• tdFile - the tag for file names, e.g. (td)(img src="images/file.gif" width=6 height=6 alt="File"). This text will preceed the name of the file.
• tdSize - the tag for size following the file name, e.g. (td align="right").
• tdDate - the tag for date following the file size, e.g.(td).

Specified by:

performAction in interface IncludeCgiPrintInterface

Parameters:

session - The current HTTP session.

resource - The HTTP resource for which the CGI is being executed.

element - The HTML element where this CGI is included in.

out - The PrintWriter to which the part of the HTML document should be printed to.

Throws:

IOException - for IO errors.

listDirectory

public static void listDirectory(HttpSession session,
                                 Element element,
                                 String dir,
                                 PrintWriter out)

Prints the directory listing to the print writer. If the parameter fileRef is null or empty, no hyperlinks for the files will be created.