Attualmente sono supportate tre classi principali definite nelle sezioni CGI, Email e HTML. Sto considerando di aggiungere le classi per trattare l'input e l'output MIME-formatted rispettivamente con MIMEin & MIMEout.
Esistono anche classi di supporto e di test definite nelle sezioni
CGI_Test,
Email_Test e
HTML_Test. L'utilizzo di queste classi è stato concepito con lo scopo di testare la vostra installazione.
Ciononostante possono essere utilizzate come punto di partenza per i vostri programmi in Java che fanno uso di questa libreria di classi.
La classe descritta nella sezione
Text è la superclasse per entrambe le classi Email e HTML.
public class CGI
La classe CGI mantiene la variabile d'ambiente ``CGI Information'' impostata dal server web e il nome/valore inviato da un form quando si decide di selezionare l'azione submit.
Tutte le informazioni sono memorizzate in un oggetto della classe Properties.
Questa classe è nel pacchetto ``Orbits.net''.
CGI() // Costruttore.
getNames() // Prende la lista di nomi.
getValue() // Prende il valore del form specificando il nome.
CGI_Test.
Costruisce un oggetto che contiene i dati CGI disponibili.
public CGI()
Quando viene costruito un oggetto CGI, tutte le informazioni disponibili vengono assorbite ed immagazzinate localmente al nuovo oggetto.
Lista i nomi che sono definiti per avere valori corrispondenti.
public Enumeration getKeys ()
Fornisce la lista intera di nome per i quali sono definiti valori corrispondenti.
Una Enumerazione di tutti i nomi definiti.
Ricerca i valori associati al nome specificato.
public String getValue ( String name )
Questo metodo fornisce una corrispondenza tra
nomi e valori inviati da un form HTML.
La chiave con la quale i valori vengono selezionati.
Una Stringa che contiene il valore.
Questa classe fornisce un esempio di come usare la classe CGI ed anche un programma di test che può essere usato per avere la conferma che il pacchetto Java CGI funzioni correttamente.
main() // Programma main().
CGI.
Fornire un metodo main().
public static void main( String argv[] )
Questo è il punto di ingresso del programma CGI che restituisce una lista delle coppie nomi/valori disponibili e il loro valore attuale.
Argomenti passati al programma dallo script java.cgi.
Attualmente inutilizzato.
public class Email extends Text
I Messaggi sono costruiti con la classe Text e i metodi
add*() e i metodi specifici e-mail-specific aggiunti a da
questa classe. Quando completo, il messaggio viene inviato ai suoi
destinatari.
Questa classe è contenuta nel pacchetto ``Orbits.net''.
Email() // Costruttore.
send() // Invia un messaggio e-mail.
sendTo() // Aggiunge un destinatario al messaggio.
subject() // Imposta il Subject del messaggio.
Email_Test, Text.
Costruisce un oggetto che conterrà un messaggio email.
public Email()
Costruisce un messaggio vuoto da completare da parte dei metodi Email.
Text.
Invia un messaggio e-mail.
public void send ()
Formatta ed invia il messaggio. Se non viene specificato un indirizzo di destinazione, non viene intrapresa alcuna azione.
Aggiunge una destinazione per questo messaggio.
public String sendTo ( String address )
Aggiunge address alla lista delle destinazioni per questo metodo.
Non esiste limite al numero di destinatari che un messaggio e-mail può avere. Sono sicuro che costruendo una lista abbastanza grande, potreste fare in modo da superare la memoria oppure eccedere la dimensione della lista di parametri che il vostro Agente di Trasporto della Posta è in grado di accettare.
Una destinazione a cui inviare il messaggio.
Imposta l'oggetto/subject per questo messaggio.
public void subject ( String subject )
Questo metodo imposta il testo per la riga Subject:
di un messaggio email.
Se vengono chiamati più di una volta, viene utilizzato il subject più recente.
Il testo della riga Subject: del messaggio.
Questa classe fornisce sia un esempio di come utilizzare la classe Email sia un programma di test per verificare che il pacchetto Java CGI
funzioni correttamente.
main() // Programma main().
Email.
Fornisce un metodo main().
public static void main( String argv[] )
Questo è il punto di ingresso del programma CGI che restituisce una lista delle coppie nomi/valori disponibili e il loro valore attuale.
Invierà anche questa lista agli indirizzi specificati nella variabile Email.
Argomenti passati al programma dallo script java.cgi.
Attualmente inutilizzato.
public class HTML extends Text
I Messaggi vengono costruiti con i metodi Text class
add*() e dai metodi specifici-HTML aggiunti da questa classe.
Quando completo, il messaggio viene inviato alle sue destinazioni.
Attualmente non esiste un controllo di errore per avere la conferma che i metodi di costruzione delle liste siano usati nell'ordine corretto: il programmatore deve prestare attenzione a non violare la sintassi HTML.
Questa classe è nel pacchetto ``Orbits.net''.
HTML() // Costruttore.
author() // Imposta il nome dell'autore del documento.
definitionList() // Avvia una definition list.
definitionListTerm() // Aggiunge un termine ad una definition list.
endList() // Termina una lista.
listItem() // Aggiunge una entrata ad una lista.
send() // Invia un messaggio HTML.
title() // Imposta il testo per il titolo del documento.
HTML_Test, Text.
Costruisce un oggetto che contiene un messaggio HTML.
public HTML()
Costruisce un messaggio vuoto da completare con i metodi HTML.
Text.
Imposta il nome dell'autore del documento.
public void author ( String author )
Imposta il nome dell'autore del documento in author.
Il testo da usare come autore di questo messaggio.
title().
Avvia una definition list.
public void definitionList ()
Avvia una definition list.
Una definition list è una particolare lista per la quale ogni elemento di ingresso della lista è term seguito dalla definizione text per quel termine.
L'avvio di una definition list dovrebbe essere seguito dalla creazione di almeno un termine/testo e una chiamata al metodo endList().
Da notare che, attualmente, le liste non possono essere nidificate
definitionListTerm(), endList(),
listItem().
Aggiunge un termine alla definition list.
public void definitionListTerm ()
Aggiunge un termine alla definition list.
Il testo dell'elemento lista corrente deve essere appeso al messaggio dopo che questo metodo viene chiamato e prima di un corrispondente metodo listItem venga chiamato.
definitionList(), listItem().
Termina una lista.
public void endList ()
Termina una lista. Questo metodo elimina una lista. Da notare che al momento attuale, le liste non possono essere nidificate.
definitionList().
Aggiunge una voce nella lista.
public void listItem ()
public void listItem ( String item )
public boolean listItem ( String term, String item )
Aggiunge una voce alla lista.
Se viene usato il primo form, il testo dell'elemento lista corrente
deve essere accodato al messaggio dopo che questo metodo viene
chiamato e prima che venga chiamata ogni altra lista di metodi.
Nel secondo e terzo form, il testo item è specificato come un parametro al metodo invece di (o in aggiunta) essere accodato al messaggio.
Il terzo form è specifico per le definition lists e fornisce sia i termini che una definizione dell'ingresso della lista.
Il testo di questo ingresso di lista.
Il testo di questa parte del termine di ingresso della definition list.
definitionList(), definitionListTerm(),
endList().
Invia un messaggio HTML.
public void send ()
Invia un messaggio HTML.
Imposta il testo per il titolo del documento.
public void title ( String title )
Imposta il testo per il titolo del documento.
Il testo del titolo del documento.
author().
Questa classe fornisce sia un esempio di come usare la classe HTML sia un programma di test che può essere usato per avere la conferma che il pacchetto Java CGI funzioni correttamente.
main() // Programma main().
HTML.
Fornire un metodo main().
public static void main( String argv[] )
Questo è il punto di ingresso del programma CGI che restituisce una lista delle coppie nomi/valori disponibili e il loro valore attuale.
Argomenti passati al programma dallo java.cgi.
Attualmente inutilizzato.
public abstract class Text
Questa classe è la superclasse delle classi Email e HTML.
I Messaggi sono costruiti con i metodi di questa classe poi completati e
formattati con i metodi delle sottoclassi.
Questa classe è contenuta nel pacchetto ``Orbits.text''.
Text() // Costruttore.
add() // Aggiunge testo a questo oggetto.
addLineBreak() // Aggiunge un terminatore di riga.
addParagraph() // Aggiunge un terminatore di paragrafo.
Email, HTML.
Aggiunge del testo a questo elemento.
public void add ( char addition )
public void add ( String addition )
public void add ( StringBuffer addition )
Aggiunge addition ai contenuti di questo elemento di testo.
Testo da aggiungere all'elemento di testo.
addLineBreak(), addParagraph().
Forza una terminazione di riga nel punto esatto del testo.
public void addLineBreak ()
Aggiunge una terminazione di riga al testo nel punto attuale.
add(), addParagraph().
Comincia un nuovo paragrafo.
public void add ()
Cominicia un nuovo paragrafo in questo punto del testo.
add(), addLineBreak().