home *** CD-ROM | disk | FTP | other *** search
/ Hackers Toolkit v2.0 / Hackers_Toolkit_v2.0.iso / HTML / archive / Unix / HOWTOs / JAVA-CGI < prev    next >
Text File  |  1999-11-04  |  24KB  |  842 lines
  1.   Java CGI HOWTO
  2.   by David H. Silber dhs@orbits.com
  3.   v0.4, 18 November 1996
  4.  
  5.   This HOWTO document explains how to set up your server to allow CGI
  6.   programs written in Java and how to use Java to write CGI programs.
  7.   Although HOWTO documents are targetted towards use with the Linux
  8.   operating system, this particular one is not dependant on the particu¡
  9.   lar version of unix used.
  10.  
  11.   1.  Introduction
  12.  
  13.   Because of the way that Java is designed the programmer does not have
  14.   easy access to the system's environment variables.  Because of the way
  15.   that the Java Development Kit (JDK) is set up, it is necessary to use
  16.   multiple tokens to invoke a program, which does not mesh very well
  17.   with the standard HTML forms/CGI manner of operations.  There are ways
  18.   around these limitations, and I have implemented one of them.  Read
  19.   further for details.
  20.  
  21.   1.1.  Prior Knowledge
  22.  
  23.   I am assuming that you have a general knowledge of HTML and CGI
  24.   concepts and at least a minimal knowledge of your HTTP server.  You
  25.   should also know how to program in Java, or a lot of this will not
  26.   make sense.
  27.  
  28.   1.2.  This Document
  29.  
  30.   The latest version of this document can be read at
  31.   http://www.orbits.com/software/Java_CGI.html.
  32.  
  33.   1.3.  The Package
  34.  
  35.   The latest version of the package described here can be accessed via
  36.   anonymous FTP at ftp://ftp.orbits.com/pub/software/java_cgi-0.4.tgz.
  37.   The package distribution includes SGML source for this document.
  38.  
  39.   The package is distributed under the terms of the GNU Library General
  40.   Public License.  This document can be distributed under the terms of
  41.   the Linux HOWTO copyright notice.
  42.  
  43.   If you use this software, please make some reference to
  44.   http://www.orbits.com/software/Java_CGI.html, so that others will be
  45.   able to find the Java CGI classes.
  46.  
  47.   1.4.  Shameless Plug
  48.  
  49.   This document is brought to you courtesy of Stellar Orbits Technology
  50.   Services.  (Visit us at http://www.orbits.com/ to see what we do.)
  51.  
  52.   2.  Setting Up Your Server to Run Java CGI Programs (With Explana¡
  53.   tions)
  54.  
  55.   This section will lead you through installing my Java CGI package with
  56.   copious explanations so that you know what the effects of your actions
  57.   will be.  If you just want to install the programs and don't care
  58.   about the whys & wherefores, skip to ``Setting Up Your Server to Run
  59.   Java CGI Programs (The Short Form)''.
  60.  
  61.   2.1.  System Requirements
  62.  
  63.   This software should work on any unix-like web server that has the
  64.   Java Development Kit installed.  I am using it on a Debian Linux
  65.   system running apache as the HTTP daemon.  If you find that it does
  66.   not run on your server, please contact me at dhs@orbits.com.
  67.  
  68.   Unfortunatly, the Java run-time interpreter seems to be something of a
  69.   memory hog -- you may want to throw another few megabytes of RAM onto
  70.   your server if you will be using Java CGI programs a lot.
  71.  
  72.   2.2.  Java CGI Add-On Software
  73.  
  74.   The software that I wrote to aid in this is called Java CGI.  You can
  75.   get it from ftp://www.orbits.com/pub/software/java_cgi-0.4.tgz.  (The
  76.   version number may have changed.)
  77.  
  78.   2.3.  Unpacking the Source
  79.  
  80.   Find a convenient directory to unpack this package into.  (If you
  81.   don't already have a standard place to put packages, I suggest that
  82.   you use /usr/local/src.)  Unpack the distribution with this command:
  83.  
  84.   gzip -dc java_cgi-0.4.tgz | tar -xvf -
  85.  
  86.   This will create a directory called java_cgi-0.4.  In there you will
  87.   find the files referenced in the rest of this document.  (If the ver¡
  88.   sion number has changed, use the instructions from within that distri¡
  89.   bution from this point on.)
  90.  
  91.   2.4.  Decide On Your Local Path Policies
  92.  
  93.   You need to decide where you want your Java CGI programs to live.
  94.   Generally, you will want to put them in a directory in parallel with
  95.   your cgi-bin directory.  My apache server came configured to use
  96.   /var/web/cgi-bin as the cgi-bin directory, so I use /var/web/javacgi
  97.   as the directory to put Java CGI programs in.  You probably do not
  98.   want to put your Java CGI programs into one of the existing CLASSPATH
  99.   directories.  Edit the Makefile to reflect your system configuration.
  100.   Make sure that you are logged in as the root user and run make
  101.   install.  This will compile the Java programs, modify the java.cgi
  102.   script to fit in with your system and install the programs in the
  103.   appropriate places.  If you want the HTML version of this
  104.   documentation and an HTML test document in addition, run make all
  105.   instead.
  106.  
  107.   2.5.  Testing your installation.
  108.  
  109.   Installed from the distribution are HTML documents called
  110.   javacgitest.html, javaemailtest.html and javahtmltest.html.  If you
  111.   installed all in the previous section, it will be in the directory you
  112.   specified for WEBDIR in the Makefile.  If you didn't, you can run make
  113.   test to build them from javacgitest.html-dist, javaemailtest.html-dist
  114.   and javahtmltest.html-dist.
  115.  
  116.   When you are sure that your installation is working correctly, you may
  117.   wish to remove CGI_Test.class, Email_Test.class and HTML_Test.class
  118.   from your JAVACGI directory and javacgitest.html, javaemailtest.html
  119.   and javahtmltest.html from your WEBDIR directory as they show the user
  120.   information that is normally only available to the server.
  121.  
  122.   3.  Setting Up Your Server to Run Java CGI Programs (The Short Form)
  123.  
  124.   ╖  Get the Java CGI package from
  125.      ftp://www.orbits.com/pub/software/java_cgi-0.4.tgz.  (The version
  126.      number may have changed.)
  127.  
  128.   ╖  Unpack the distribution with this command:
  129.  
  130.      gzip -dc java_cgi-0.4.tgz | tar -xvf -
  131.  
  132.   (If the version number has changed, use the instructions from within
  133.   that distribution from this point on.)
  134.  
  135.   ╖  Edit the Makefile you will find in the newly created directory
  136.      java_cgi-0.4 as appropriate to your system.
  137.  
  138.   ╖  As root, run make install.  This will compile the Java programs,
  139.      apply your system-specific information and install the various
  140.      files.  If you want the HTML version of this documentation and an
  141.      HTML test document, run make all instead.
  142.  
  143.   ╖  You should be ready to go.
  144.  
  145.   4.  Executing a Java CGI Program
  146.  
  147.   4.1.  Obstacles to Running Java Programs Under the CGI Model
  148.  
  149.   There are two main problems in running a Java program from a web
  150.   server:
  151.  
  152.   4.1.1.  You can't run Java programs like ordinary executables.
  153.  
  154.   You need to run the Java run-time interpreter and provide the initial
  155.   class (program to run) on the command-line.  With an HTML form, there
  156.   is no provision for sending a command-line to the web server.
  157.  
  158.   4.1.2.  Java does not have general access to the environment.
  159.  
  160.   Every environment variable that will be needed by the Java program
  161.   must be explicitly passed in.  There is no method similar to the C
  162.   getenv() function.
  163.  
  164.   4.2.  Overcoming Problems in Running Java CGI Programs
  165.  
  166.   To deal with these obstacles, I wrote a shell CGI program that
  167.   provides the information needed by the Java interpreter.
  168.  
  169.   4.2.1.  The java.cgi script.
  170.  
  171.   This shell script manages the interaction between the HTTP daemon and
  172.   the Java CGI program that you wish to use.  It extracts the name of
  173.   the program that you want to run from the server-provided data.  It
  174.   collects all of the environment data into a temporary file.  Then, it
  175.   runs the Java run-time interpreter with the name of the file of
  176.   environment information and the program name added to the command-
  177.   line.
  178.  
  179.   The java.cgi script was configured and installed in ``Decide On Your
  180.   Local Path Policies''.
  181.  
  182.   4.2.2.  Invoking java.cgi from an HTML form.
  183.  
  184.   My forms that use Java CGI programs specify a form action as follows:
  185.  
  186.   <form action="/cgi-bin/java.cgi/CGI_Test" method="POST">
  187.  
  188.   Where /cgi-bin/ is your local CGI binary directory, java.cgi is the
  189.   Java front-end that allows us to run Java programs over the web and
  190.   CGI_Test is an example of the name of the Java program to run.
  191.  
  192.   5.  Using the Java CGI Classes.
  193.  
  194.   There are currently three main classes supported -- ``CGI'', ``Email''
  195.   and ``HTML''.  I am considering adding classes to deal with MIME-
  196.   formatted input and output -- MIMEin & MIMEout, respectively.
  197.  
  198.   There are also a few support and test classes.  ``CGI_Test'',
  199.   ``Email_Test'' and ``HTML_Test'' are intended to be used to test your
  200.   installation.  They can also be used as a starting-point for your own
  201.   Java programs which use this class library.  The ``Text'' class is the
  202.   superclass for both the Email and the HTML classes.
  203.  
  204.   5.1.  CGI
  205.  
  206.   5.1.1.  Class Syntax
  207.  
  208.   public class CGI
  209.  
  210.   5.1.2.  Class Description
  211.  
  212.   The CGI class holds the ``CGI Information'' -- Environment variables
  213.   set by the web server and the name/value sent from a form when its
  214.   submit action is selected.  All information is stored in a Properties
  215.   class object.
  216.  
  217.   This class is in the ``Orbits.net'' package.
  218.  
  219.   5.1.3.  Member Summary
  220.  
  221.   ______________________________________________________________________
  222.           CGI()         //  Constructor.
  223.           getNames()    //  Get the list of names.
  224.           getValue()    //  Get form value by specifying name.
  225.   ______________________________________________________________________
  226.  
  227.   5.1.4.  See Also
  228.  
  229.   CGI_Test.
  230.  
  231.   5.1.5.  CGI()
  232.  
  233.      Purpose
  234.         Constructs an object which contains the available CGI data.
  235.  
  236.      Syntax
  237.         public CGI()
  238.  
  239.      Description
  240.         When a CGI object is constructed, all available CGI information
  241.         is sucked-up into storage local to the new object.
  242.  
  243.   5.1.6.  getNames()
  244.  
  245.      Purpose
  246.         List the names which are defined to have corresponding values.
  247.  
  248.      Syntax
  249.         public Enumeration getKeys ()
  250.  
  251.      Description
  252.         Provides the full list of names for which coresponding values
  253.         are defined.
  254.  
  255.      Returns
  256.         An Enumeration of all the names defined.
  257.  
  258.   5.1.7.  getValue()
  259.  
  260.      Purpose
  261.         Retrieves the value associated with the name specified.
  262.  
  263.      Syntax
  264.         public String getValue ( String name )
  265.  
  266.      Description
  267.         This method provides the corespondence between the names and
  268.         values sent from an HTML form.
  269.  
  270.      Parameter
  271.         "
  272.  
  273.         name
  274.            The key by which values are selected.
  275.  
  276.      Returns
  277.         A String containing the value.
  278.  
  279.   5.2.  CGI_Test
  280.  
  281.   This class provides both an example of how to use the CGI class and a
  282.   test program which can be used to confirm that the Java CGI package is
  283.   functioning correctly.
  284.  
  285.   5.2.1.  Member Summary
  286.  
  287.   ______________________________________________________________________
  288.           main()      //  Program main().
  289.   ______________________________________________________________________
  290.  
  291.   5.2.2.  See Also
  292.  
  293.   CGI.
  294.  
  295.   5.2.3.  main()
  296.  
  297.      Purpose
  298.         Provide a main() method.
  299.  
  300.      Syntax
  301.         public static void main( String argv[] )
  302.  
  303.      Description
  304.         This is the entry point for a CGI program which does nothing but
  305.         return a list of the available name/value pairs and their
  306.         current values.
  307.  
  308.      Parameter
  309.  
  310.         argv[]
  311.            Arguments passed to the program by the java.cgi script.
  312.            Currently unused.
  313.  
  314.   5.3.  Email
  315.  
  316.   5.3.1.  Class Syntax
  317.  
  318.   public class Email extends Text
  319.  
  320.   5.3.2.  Class Description
  321.  
  322.   Messages are built up with the Text class add*() methods and the e-
  323.   mail-specific methods added by this class.  When complete, the message
  324.   is sent to its destination.
  325.  
  326.   This class is in the ``Orbits.net'' package.
  327.  
  328.   5.3.3.  Member Summary
  329.  
  330.   ______________________________________________________________________
  331.           Email()      //  Constructor.
  332.           send()       //  Send the e-mail message.
  333.           sendTo()     //  Add a destination for message.
  334.           subject()    //  Set the Subject: for message.
  335.   ______________________________________________________________________
  336.  
  337.   5.3.4.  See Also
  338.  
  339.   Email_Test, Text.
  340.  
  341.   5.3.5.  Email()
  342.  
  343.      Purpose
  344.         Constructs an object which will contain an email message.
  345.  
  346.      Syntax
  347.         public Email()
  348.  
  349.      Description
  350.         Sets up an empty message to be completed by the Email methods.
  351.  
  352.      See Also
  353.         Text.
  354.  
  355.   5.3.6.  send()
  356.  
  357.      Purpose
  358.         Send the e-mail message.
  359.  
  360.      Syntax
  361.         public void send ()
  362.  
  363.      Description
  364.         This formats and sends the message.  If no destination address
  365.         has been set, there is no action taken.
  366.  
  367.   5.3.7.  sendTo()
  368.  
  369.      Purpose
  370.         Add a destination for this message.
  371.  
  372.      Syntax
  373.         public String sendTo ( String address )
  374.  
  375.      Description
  376.         Add address to the list of destinations for this method.  There
  377.         is no set limit to the number of destinations an e-mail message
  378.         may have.  I'm sure that if you build up the list large enough,
  379.         you can exceed the size of the parameter list that the Mail
  380.         Transport Agent can accept or use up your memory.
  381.  
  382.      Parameter/
  383.         "
  384.  
  385.         address
  386.            A destination to send this message to.
  387.  
  388.   5.3.8.  subject()
  389.  
  390.      Purpose
  391.         Set the subject for this message.
  392.  
  393.      Syntax
  394.         public void subject ( String subject )
  395.  
  396.      Description
  397.         This method sets the text for the e-mail's Subject: line.  If
  398.         called more than once, the latest subject set is the one that is
  399.         used.
  400.  
  401.      Parameter
  402.  
  403.         subject
  404.            The text of this message's Subject: line.
  405.  
  406.   5.4.  Email_Test
  407.  
  408.   This class provides both an example of how to use the Email class and
  409.   a test program which can be used to confirm that the Java CGI package
  410.   is functioning correctly.
  411.  
  412.   5.4.1.  Member Summary
  413.  
  414.   ______________________________________________________________________
  415.           main()      //  Program main().
  416.   ______________________________________________________________________
  417.  
  418.   5.4.2.  See Also
  419.  
  420.   Email.
  421.  
  422.   5.4.3.  main()
  423.  
  424.      Purpose
  425.         Provide a main() method.
  426.  
  427.      Syntax
  428.         public static void main( String argv[] )
  429.  
  430.      Description
  431.         This is the entry point for a CGI program which returns a list
  432.         of the available name/value pairs and their current values.  It
  433.         will also send this list to the address specified in the Email
  434.         variable.
  435.  
  436.      Parameter
  437.  
  438.         argv[]
  439.            Arguments passed to the program by the java.cgi script.
  440.            Currently unused.
  441.  
  442.   5.5.  HTML
  443.  
  444.   5.5.1.  Class Syntax
  445.  
  446.   public class HTML extends Text
  447.  
  448.   5.5.2.  Class Description
  449.  
  450.   Messages are built up with the Text class add*() methods and the HTML-
  451.   specific methods added by this class.  When complete, the message is
  452.   sent to its destination.
  453.  
  454.   Currently, there is no error checking to confirm that the list-
  455.   building methods are being used in a correct order, so the  programmer
  456.   must take pains not to violate HTML syntax.
  457.  
  458.   This class is in the ``Orbits.net'' package.
  459.  
  460.   5.5.3.  Member Summary
  461.  
  462.   ______________________________________________________________________
  463.           HTML()                  //  Constructor.
  464.           author()                //  Set the name of the document author.
  465.           definitionList()        //  Start a definition list.
  466.           definitionListTerm()    //  Add a term to a definition list.
  467.           endList()               //  End a list.
  468.           listItem()              //  Add an entry to a list.
  469.           send()                  //  Send the HTML message.
  470.           title()                 //  Set the text for the document title.
  471.   ______________________________________________________________________
  472.  
  473.   5.5.4.  See Also
  474.  
  475.   HTML_Test, Text.
  476.  
  477.   5.5.5.  HTML()
  478.  
  479.      Purpose
  480.         Constructs an object which will contain an HTML message.
  481.  
  482.      Syntax
  483.         public HTML()
  484.  
  485.      Description
  486.         Sets up an empty message to be completed by the HTML methods.
  487.  
  488.      See Also
  489.         Text.
  490.  
  491.   5.5.6.  author()
  492.  
  493.      Purpose
  494.         Set the name of the document author.
  495.  
  496.      Syntax
  497.         public void author ( String author )
  498.  
  499.      Description
  500.         Set the name of the document author to author.
  501.  
  502.      Parameter/
  503.         "
  504.  
  505.         author
  506.            The text to use as the author of this message.
  507.  
  508.      See Also
  509.         title().
  510.  
  511.   5.5.7.  definitionList()
  512.  
  513.      Purpose
  514.         Start a definition list.
  515.  
  516.      Syntax
  517.         public void definitionList ()
  518.  
  519.      Description
  520.         Start a definition list.  A definition list is a list
  521.         specialized so that each entry in the list is a term followed by
  522.         the definition text for that term.  The start of a definition
  523.         list should be followed by the creation of (at least) one
  524.         term/text pair and a call to the endList() method.  Note that,
  525.         currently, lists cannot be nested.
  526.  
  527.      See Also
  528.         definitionListTerm(), endList(), listItem().
  529.  
  530.   5.5.8.  definitionListTerm()
  531.  
  532.      Purpose
  533.         Add a term to a definition list.
  534.  
  535.      Syntax
  536.         public void definitionListTerm ()
  537.  
  538.      Description
  539.         Add a term to a definition list.  The text for the term part of
  540.         the current list entry should be appended to the message after
  541.         this method is called and before a corresponding listItem method
  542.         is called.
  543.  
  544.      See Also
  545.         definitionList(), listItem().
  546.  
  547.   5.5.9.  endList()
  548.  
  549.      Purpose
  550.         End a list.
  551.  
  552.      Syntax
  553.         public void endList ()
  554.  
  555.      Description
  556.         End a list.  This method closes out a list.  Note that,
  557.         currently, lists cannot be nested.
  558.  
  559.      See Also
  560.         definitionList().
  561.  
  562.   5.5.10.  listItem()
  563.  
  564.      Purpose
  565.         Add an entry to a list.
  566.  
  567.      Syntax
  568.         public void listItem ()
  569.  
  570.         public void listItem ( String item )
  571.  
  572.         public boolean listItem ( String term, String item )
  573.  
  574.      Description
  575.         Add an entry to a list.  If the first form is used, the text for
  576.         the current list item should be appended to the message after
  577.         this method is called and before any other list methods are
  578.         called.  In the second and third forms, the item text is
  579.         specified as a parameter to the method instead of (or in
  580.         addition to) being appended to the message.  The third form is
  581.         specific to definition lists and provides both the term and the
  582.         definition of the list entry.
  583.  
  584.      Parameters
  585.  
  586.         item
  587.            The text of this list entry.
  588.  
  589.         term
  590.            The text of this definition list entry's term part.
  591.  
  592.      See Also
  593.         definitionList(), definitionListTerm(), endList().
  594.  
  595.   5.5.11.  send()
  596.  
  597.      Purpose
  598.         Send the HTML message.
  599.  
  600.      Syntax
  601.         public void send ()
  602.  
  603.      Description
  604.         Send the HTML message.
  605.  
  606.   5.5.12.  title()
  607.  
  608.      Purpose
  609.         Set the text for the document title.
  610.  
  611.      Syntax
  612.         public void title ( String title )
  613.  
  614.      Description
  615.         Set the text for the document title.
  616.  
  617.      Parameter
  618.  
  619.         title
  620.            The text of this message's title.
  621.  
  622.      See Also
  623.         author().
  624.  
  625.   5.6.  HTML_Test
  626.  
  627.   This class provides both an example of how to use the HTML class and a
  628.   test program which can be used to confirm that the Java CGI package is
  629.   functioning correctly.
  630.  
  631.   5.6.1.  Member Summary
  632.  
  633.   ______________________________________________________________________
  634.           main()      //  Program main().
  635.   ______________________________________________________________________
  636.  
  637.   5.6.2.  See Also
  638.  
  639.   HTML.
  640.  
  641.   5.6.3.  main()
  642.  
  643.      Purpose
  644.         Provide a main() method.
  645.  
  646.      Syntax
  647.         public static void main( String argv[] )
  648.  
  649.      Description
  650.         This is the entry point for a CGI program which returns a list
  651.         of the available name/value pairs in an HTML document, with each
  652.         name/value pair displayed in a definition list element.
  653.  
  654.      Parameter
  655.  
  656.         argv[]
  657.            Arguments passed to the program by the java.cgi script.
  658.            Currently unused.
  659.  
  660.   5.7.  Text
  661.  
  662.   5.7.1.  Class Syntax
  663.  
  664.   public abstract class Text
  665.  
  666.   5.7.2.  Class Description
  667.  
  668.   This class is the superclass of the Email and HTML classes.  Messages
  669.   are built up with the methods in this class and completed and
  670.   formatted with the methods in subclasses.
  671.  
  672.   This class is in the ``Orbits.text'' package.
  673.  
  674.   5.7.3.  Member Summary
  675.  
  676.   ______________________________________________________________________
  677.           Text()            //  Constructor.
  678.           add()             //  Add text to this object.
  679.           addLineBreak()    //  Add a line break.
  680.           addParagraph()    //  Add a paragraph break.
  681.   ______________________________________________________________________
  682.  
  683.   5.7.4.  See Also
  684.  
  685.   Email, HTML.
  686.  
  687.   5.7.5.  add()
  688.  
  689.      Purpose
  690.         Add text to this item.
  691.  
  692.      Syntax
  693.         public void add ( char addition )
  694.  
  695.         public void add ( String addition )
  696.  
  697.         public void add ( StringBuffer addition )
  698.  
  699.      Description
  700.         Add addition to the contents of this text item.
  701.  
  702.      Parameter
  703.  
  704.         addition
  705.            Text to be added to the text item.
  706.  
  707.      See Also
  708.         addLineBreak(), addParagraph().
  709.  
  710.   5.7.6.  addLineBreak()
  711.  
  712.      Purpose
  713.         Force a line break at this point in the text.
  714.  
  715.      Syntax
  716.         public void addLineBreak ()
  717.  
  718.      Description
  719.         Add a line break to the text at the current point.
  720.  
  721.      See Also
  722.         add(), addParagraph().
  723.  
  724.   5.7.7.  addParagraph()
  725.  
  726.      Purpose
  727.         Start a new paragaph.
  728.  
  729.      Syntax
  730.         public void add ()
  731.  
  732.      Description
  733.         Start a new paragraph at this point in the text flow.
  734.  
  735.      See Also
  736.         add(), addLineBreak().
  737.   6.  Future Plans
  738.  
  739.   ╖  Add to the Email class:
  740.  
  741.      Email( int capacity )
  742.         Used when we know how much space the message will need to have
  743.         allocated.
  744.  
  745.      sendTo( String  address )
  746.         Add a list of primary destinations to the e-mail message.
  747.  
  748.      sendCc( String address )
  749.         Add a Carbon-Copy destination to the e-mail message.
  750.  
  751.      sendCc( String  address )
  752.         Add a list of Carbon-Copy destinations to the e-mail message.
  753.  
  754.      sendBcc( String address )
  755.         Add a Blind Carbon-Copy destination to the e-mail message.
  756.  
  757.      sendBcc( String  address )
  758.         Add a list of Blind Carbon-Copy destinations to the e-mail
  759.         message.
  760.  
  761.   ╖  Add to the HTML class:
  762.  
  763.      HTML( int capacity )
  764.         Used when we know how much space the message will need to have
  765.         allocated.
  766.  
  767.      public void unorderedList()
  768.         Start an unordered list.
  769.  
  770.      public void orderedList()
  771.         Start an ordered list.
  772.  
  773.      public void directoryList()
  774.         Start a directory list.
  775.  
  776.      public void menuList()
  777.         Start a menu list.
  778.  
  779.      void anchor( String anchorName )
  780.         Specify an anchor.
  781.  
  782.      void link( String url, String text )
  783.         Specify a link.
  784.  
  785.      void applet( String url, String altText )
  786.         Specify an applet link.
  787.  
  788.   ╖  Allow HTML lists to be nested.
  789.  
  790.   ╖  Add error checking code to enforce correct ordering of HTML list
  791.      formatting codes.
  792.  
  793.   ╖  The location of the file of environment data should be configurable
  794.      from the Makefile.
  795.  
  796.   ╖  Get rid of the spurious empty name/value pair that appears in the
  797.      list when we are dealing with the GET method of data transfer.
  798.  
  799.   ╖  Consider having CGI implement the java.util.Enumeration interface
  800.      to successively provide variable names.
  801.  
  802.   ╖  Add a Test class, which would use every method in this package.
  803.  
  804.   ╖  Document how CGI_Test, Email_Test and HTML_Test build on each other
  805.      to provide incremental tests for debugging purposes.
  806.  
  807.   ╖  Document how Test uses every feature available in this package.
  808.  
  809.   7.  Changes
  810.  
  811.   7.1.  Changes from 0.3 to 0.4
  812.  
  813.   ╖  Fleshed out the HTML class to provide minimal functionality.
  814.  
  815.   ╖  Wrote the HTML_Test class and javahtmltest.html-dist.
  816.  
  817.   ╖  Added the HTML methods to deal with a definition list.
  818.  
  819.   7.2.  Changes from 0.2 to 0.3
  820.  
  821.   ╖  Added the Text and Email classes.  HTML was also added, but it is
  822.      merely a stub at this point.
  823.  
  824.   ╖  Put the various classes into packages.  The main classes are in
  825.      Orbits.net.*, the support class Text is in Orbits.text.Text.
  826.  
  827.   ╖  Changed CGItest to CGI_Test.
  828.  
  829.   ╖  Added the Email_Test class.
  830.  
  831.   7.3.  Changes from 0.1 to 0.2
  832.  
  833.   ╖  The environment variables are put into a temportary file instead of
  834.      being crammed into the Java inperpreter command-line.  The CGI
  835.      class and java.cgi had to be modified.
  836.  
  837.   ╖  The javacgitest.html document is made part of the distribution.
  838.  
  839.   ╖  The text files which are modified by make upon installation are
  840.      provided with names that end with -dist.
  841.  
  842.