javacgi-document@orbits.com
Because of the way that Java is designed the programmer does not have easy access to the system's environment variables. Because of the way that the Java Development Kit (JDK) is set up, it is necessary to use multiple tokens to invoke a program, which does not mesh very well with the standard HTML forms/CGI manner of operations. There are ways around these limitations, and I have implemented one of them. Read further for details.
Since I wrote the previous paragraph in 1996, there have been many changes in the Java technology. It is likely that a better solution to running server-side Java programs is now available -- perhaps you should take a look at servlets.
I am assuming that you have a general knowledge of HTML and CGI concepts and at least a minimal knowledge of your HTTP server. You should also know how to program in Java, or a lot of this will not make sense.
The latest version of this document can be read at http://www.orbits.com/software/Java_CGI.html.
The latest version of the package described here can be accessed via anonymous FTP at ftp://ftp.orbits.com/pub/software/java_cgi-0.5.tgz. The package distribution includes SGML source for this document.
The package is distributed under the terms of the GNU Library General Public License. This document can be distributed under the terms of the Linux HOWTO copyright notice.
If you use this software, please make some reference to http://www.orbits.com/software/Java_CGI.html, so that others will be able to find the Java CGI classes.
I have run out of time to maintain and support this package, so this
will probably be its final release.
If anyone out there is sufficiently enamoured of this software that
they wish to take over the maintenace of it, please contact me at
javacgi-document@orbits.com.
I have created a majordomo list to allow people to help each-other work
through their mutual problems in installing and using this software.
Send a message to
javacgi-request@orbits.com,
containing the word subscribe.
This section will lead you through installing my Java CGI package with copious explanations so that you know what the effects of your actions will be. If you just want to install the programs and don't care about the whys & wherefores, skip to Setting Up Your Server to Run Java CGI Programs (The Short Form).
This software should work on any unix-like web server that has the Java Development Kit installed. I am using it on a Debian Linux system running apache as the HTTP daemon. If you find that it does not run on your server, please contact the mailing list. See The Mailing List for details.
Unfortunatly, the Java run-time interpreter seems to be something of a memory hog -- you may want to throw another few megabytes of RAM onto your server if you will be using Java CGI programs a lot.
The software that I wrote to aid in this is called Java CGI. You can get it from ftp://ftp.orbits.com/pub/software/java_cgi-0.5.tgz. (The version number may have changed.)
Find a convenient directory to unpack this package into.
(If you don't already have a standard place to put packages,
I suggest that you use /usr/local/src.)
Unpack the distribution with this command:
gzip -dc java_cgi-0.5.tgz | tar -xvf -This will create a directory called
java_cgi-0.5.
In there you will find the files referenced in the rest of this document.
(If the version number has changed, use the instructions from within
that distribution from this point on.)
You need to decide where you want your Java CGI
programs to live. Generally, you will want to put them in a directory in
parallel with your cgi-bin directory. My apache
server came configured to use /var/www/cgi-bin as the
cgi-bin directory, so I use /var/www/javacgi as the
directory to put Java CGI programs in. You probably do not want to
put your Java CGI programs into one of the existing
CLASSPATH directories.
Edit the Makefile to reflect your system configuration.
Make sure that you are logged in as the root user and run make install.
This will compile the Java programs, modify the java.cgi script
to fit in with your system and install the programs in the appropriate
places.
If you want the HTML version of this documentation and an HTML test document
in addition, run make all instead.
Installed from the distribution are HTML documents called
javacgitest.html, javaemailtest.html and
javahtmltest.html.
If you installed all in the previous section, it will be in the
directory you specified for WEBDIR in the Makefile.
If you didn't, you can run make test to build them from
javacgitest.html-dist, javaemailtest.html-dist and
javahtmltest.html-dist.
When you are sure that your installation is working correctly, you may
wish to remove CGI_Test.class, Email_Test.class and
HTML_Test.class from
your JAVACGI directory and javacgitest.html,
javaemailtest.html and javahtmltest.html
from your WEBDIR directory as they show the
user information that is normally only available to the server.
gzip -dc java_cgi-0.5.tgz | tar -xvf -(If the version number has changed, use the instructions from within that distribution from this point on.)
Makefile you will find in the newly created directory
java_cgi-0.5 as appropriate to your system.make install.
This will compile the Java programs, apply your system-specific information
and install the various files.
If you want the HTML version of this documentation and an HTML test document,
run make all instead.
There are two main problems in running a Java program from a web server:
You need to run the Java run-time interpreter and provide the initial class (program to run) on the command-line. With an HTML form, there is no provision for sending a command-line to the web server.
Every environment variable that will be needed by the Java program
must be explicitly passed in.
There is no method similar to the C getenv() function.
To deal with these obstacles, I wrote a shell CGI program that provides the information needed by the Java interpreter.
This shell script manages the interaction between the HTTP daemon and the Java CGI program that you wish to use. It extracts the name of the program that you want to run from the server-provided data. It collects all of the environment data into a temporary file. Then, it runs the Java run-time interpreter with the name of the file of environment information and the program name added to the command-line.
The java.cgi script was configured and installed in
Decide On Your Local Path Policies.
My forms that use Java CGI programs specify a form action as follows:
<form action="/cgi-bin/java.cgi/CGI_Test" method="POST">Where
/cgi-bin/ is your local CGI binary directory,
java.cgi is the Java front-end that allows us to run Java programs
over the web
and CGI_Test is an example of the name of the Java program to run.
There are currently three main classes supported -- CGI, Email and HTML. I am considering adding classes to deal with MIME-formatted input and output -- MIMEin & MIMEout, respectively.
There are also a few support and test classes.
CGI_Test,
Email_Test and
HTML_Test are intended to be used to
test your installation.
They can also be used as a starting-point for your own Java programs
which use this class library.
The
Text class is the superclass for both the
Email and the HTML classes.
public class CGI
The CGI class holds the ``CGI Information'' -- Environment variables
set by the web server and the name/value sent from a
form when its submit action is selected.
All information is stored in a Properties class object.
This class is in the ``Orbits.net'' package.
CGI() // Constructor.
getNames() // Get the list of names.
getValue() // Get form value by specifying name.
CGI_Test.
Constructs an object which contains the available CGI data.
public CGI()
When a CGI object is constructed, all available CGI information is sucked-up into storage local to the new object.
List the names which are defined to have corresponding values.
public Enumeration getKeys ()
Provides the full list of names for which coresponding values are defined.
An Enumeration of all the names defined.
Retrieves the value associated with the name specified.
public String getValue ( String name )
This method provides the corespondence between the
names and values sent from an HTML form.
The key by which values are selected.
A String containing the value.
This class provides both an example of how to use the CGI class
and a test program which can be used to confirm that the Java CGI
package is functioning correctly.
main() // Program main().
CGI.
Provide a main() method.
public static void main( String argv[] )
This is the entry point for a CGI program which does nothing but return a list of the available name/value pairs and their current values.
Arguments passed to the program by
the java.cgi script.
Currently unused.
public class Email extends Text
Messages are built up with the Text class add*() methods
and the e-mail-specific methods added by this class.
When complete, the message is sent to its destination.
This class is in the ``Orbits.net'' package.
Email() // Constructor.
send() // Send the e-mail message.
sendTo() // Add a destination for message.
subject() // Set the Subject: for message.
Email_Test, Text.
Constructs an object which will contain an email message.
public Email()
Sets up an empty message to be completed by the Email methods.
Text.
Send the e-mail message.
public void send ()
This formats and sends the message. If no destination address has been set, there is no action taken.
Add a destination for this message.
public String sendTo ( String address )
Add address to the list of destinations for
this method.
There is no set limit to the number of destinations an e-mail message may have.
I'm sure that if you build up the list large enough, you can
exceed the size of the parameter list that the Mail Transport
Agent can accept or use up your memory.
A destination to send this message to.
Set the subject for this message.
public void subject ( String subject )
This method sets the text for the e-mail's Subject:
line.
If called more than once, the latest subject set is the one that is used.
The text of this message's Subject: line.
This class provides both an example of how to use the Email class
and a test program which can be used to confirm that the Java CGI
package is functioning correctly.
main() // Program main().
Email.
Provide a main() method.
public static void main( String argv[] )
This is the entry point for a CGI program which returns
a list of the available name/value pairs and their current values.
It will also send this list to the address specified in the Email
variable.
Arguments passed to the program by
the java.cgi script.
Currently unused.
public class HTML extends Text
Messages are built up with the Text class add*() methods
and the HTML-specific methods added by this class.
When complete, the message is sent to its destination.
Currently, there is no error checking to confirm that the list-building methods are being used in a correct order, so the programmer must take pains not to violate HTML syntax.
This class is in the ``Orbits.net'' package.
HTML() // Constructor.
author() // Set the name of the document author.
definitionList() // Start a definition list.
definitionListTerm() // Add a term to a definition list.
endList() // End a list.
listItem() // Add an entry to a list.
send() // Send the HTML message.
title() // Set the text for the document title.
HTML_Test, Text.
Constructs an object which will contain an HTML message.
public HTML()
Sets up an empty message to be completed by the HTML methods.
Text.
Set the name of the document author.
public void author ( String author )
Set the name of the document author to author.
The text to use as the author of this message.
title().
Start a definition list.
public void definitionList ()
Start a definition list.
A definition list is a list specialized so that each entry in
the list is a term followed by the definition text
for that term.
The start of a definition list should be followed by the creation of
(at least) one term/text pair and a call to the endList() method.
Note that, currently, lists cannot be nested.
definitionListTerm(), endList(),
listItem().
Add a term to a definition list.
public void definitionListTerm ()
Add a term to a definition list.
The text for the term part of the current list entry should be appended
to the message after this method is called and before a corresponding
listItem method is called.
definitionList(), listItem().
End a list.
public void endList ()
End a list. This method closes out a list. Note that, currently, lists cannot be nested.
definitionList().
Add an entry to a list.
public void listItem ()
public void listItem ( String item )
public boolean listItem ( String term, String item )
Add an entry to a list.
If the first form is used, the text for the current list item should be
appended to the message after this method is called and before any other
list methods are called.
In the second and third forms, the item text is specified as a
parameter to the method instead of (or in addition to) being appended to
the message.
The third form is specific to definition lists and provides both the
term and the definition of the list entry.
The text of this list entry.
The text of this definition list entry's term part.
definitionList(), definitionListTerm(),
endList().
Send the HTML message.
public void send ()
Send the HTML message.
Set the text for the document title.
public void title ( String title )
Set the text for the document title.
The text of this message's title.
author().
This class provides both an example of how to use the HTML class
and a test program which can be used to confirm that the Java CGI
package is functioning correctly.
main() // Program main().
HTML.
Provide a main() method.
public static void main( String argv[] )
This is the entry point for a CGI program which returns a list of the available name/value pairs in an HTML document, with each name/value pair displayed in a definition list element.
Arguments passed to the program by
the java.cgi script.
Currently unused.
public abstract class Text
This class is the superclass of the Email and HTML
classes.
Messages are built up with the methods in this class and completed and
formatted with the methods in subclasses.
This class is in the ``Orbits.text'' package.
Text() // Constructor.
add() // Add text to this object.
addLineBreak() // Add a line break.
addParagraph() // Add a paragraph break.
Email, HTML.
Add text to this item.
public void add ( char addition )
public void add ( String addition )
public void add ( StringBuffer addition )
Add addition to the contents of this text item.
Text to be added to the text item.
addLineBreak(), addParagraph().
Force a line break at this point in the text.
public void addLineBreak ()
Add a line break to the text at the current point.
add(), addParagraph().
Start a new paragaph.
public void add ()
Start a new paragraph at this point in the text flow.
add(), addLineBreak().
Used when we know how much space the message will need to have allocated.
Add a list of primary destinations to the e-mail message.
Add a Carbon-Copy destination to the e-mail message.
Add a list of Carbon-Copy destinations to the e-mail message.
Add a Blind Carbon-Copy destination to the e-mail message.
Add a list of Blind Carbon-Copy destinations to the e-mail message.
Used when we know how much space the message will need to have allocated.
Start an unordered list.
Start an ordered list.
Start a directory list.
Start a menu list.
Specify an anchor.
Specify a link.
Specify an applet link.
Makefile.Test class, which would use every method in this package.CGI_Test, Email_Test and
HTML_Test build on each other to provide incremental tests for
debugging purposes.
Orbits.net.*, the support class
Text is in Orbits.text.Text.CGItest to CGI_Test.Email_Test class.
CGI class and java.cgi had to be modified.javacgitest.html document is made part of the distribution.make upon installation are
provided with names that end with -dist.