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().