dhs@orbits.comA causa del metodo con cui Java è stato scritto, il programmatore non ha un accesso molto semplice alle variabili d'ambiente del sistema. Inoltre, per le modalità con cui il Java Development Kit (JDK) è stato costruito, per lanciare un programma è necessario utilizzare segnali multipli, cosa che non si addice molto alla metodologia di operazioni dello standard HTML forms/CGI. Esistono vari metodi per eliminare queste limitazioni, ed io ho implementato uno di questi. Il seguito di questo documento ne spiega tutti i dettagli.
Si assume che abbiate una conoscenza generale del linguaggio HTML e dei concetti legati al CGI e almeno una minima conoscenza del vostro server HTTP. Dovreste anche conoscere la programmazione in Java o molto di quanto leggerete non avrà granché senso.
La versione più recente di questo documento si può trovare presso http://www.orbits.com/software/Java_CGI.html.
La versione più recente del pacchetto software descritto può essere scaricata mediante FTP anonimo presso ftp://ftp.orbits.com/pub/software/java_cgi-0.4.tgz.La distribuzione del pacchetto include anche un sorgente SGML di questo documento.
Il pacchetto è distribuito nei termini della GNU Library General Public License. Questo documento può essere distribuito nei termini della nota di copyright degli HOWTO di Linux.
Se utilizzate questo software, rendete disponibile un collegamento alla pagina http://www.orbits.com/software/Java_CGI.html, cosicché altre persone possano trovare le classi CGI Java.
Questo documento vi proposto viene grazie a Stellar Orbits Technology Services. (Visitate il nostro sito http://www.orbits.com/ per vedere di cosa ci occupiamo.)
Questa sezione vi guiderà nella installazione dei miei pacchetti Java CGI con spiegazioni approfondite per farvi capire quali siano gli effetti di tutte le vostre azioni. Se volete solo installare i programmi e non vi interessano tutti i motivi ed i perché, saltate alla sezione Come Configurare il Vostro Server per lanciare Programmi Java CGI (forma abbreviata).
Questo software dovrebbe funzionare su un qualsiasi web server unix-like che ha il Java Development Kit installato. Io lo utilizzo su un sistema con Debian Linux che usa apache come demone HTTP. Se non dovesse funzionare sul vostro server, contattatemi presso
dhs@orbits.com.
Sfortunatamente, l'interprete run-time di Java sembra essere veramente ingordo di memoria -- potreste avere la necessità di installare qualche altro megabyte di RAM nel vostro server se vorrete usare estensivamente le capacità dei programmi Java CGI.
Il software di cui ho scritto il codice è chiamato Java CGI. Potete scaricarlo dal sito ftp: ftp://www.orbits.com/pub/software/java_cgi-0.4.tgz. (Il numero della versione potrebbe essere cambiato).
Scegliete opportunamente una directory per decomprimere il pacchetto.
(Se non avete ancora fissato un posto standard in cui installare i pacchetti software, suggerisco di utilizzare /usr/local/src.)
Per decomprimere il file contenente la distribuzione si utilizza il seguente comando:
gzip -dc java_cgi-0.4.tgz | tar -xvf -Questo comando creerà una directory chiamata
java_cgi-0.4. All'interno di questa directory troverete tutti i file a cui farò riferimento nel resto del documento.
(Se il numero della versione è cambiato, consultate le istruzioni contenute nella distribuzione per continuare l'installazione).
A questo punto dovete decidere dove volete che i vostri programmi Java CGI
risiedano. Generalmente si mettono in una directory in
parallelo con la directory cgi-bin. Il mio server apache
è configurato per usare /var/web/cgi-bin come directory
cgi-bin, per cui uso /var/web/javacgi come la
directory in cui inserire programmi Java. Probabilmente è meglio non mettere i vostri programmi Java CGI nelle
directory esistenti nel CLASSPATH.
Modificate il Makefile per fare in modo che esso che si adatti alla configurazion del vostro sistema.
Come root lanciate make install.
Questo compilerà i programmi Java, modificate lo script java.cgi per fare in modo che si adatti al vostro sistema ed installi i programmi nei posti giusti.
Se invece volete avere la versione HTML di questo documento e una pagina HTML di test in aggiunta, lanciate make all.
Assieme alla distribuzione trovere dei documenti HTML chiamati javacgitest.html, javaemailtest.html e javahtmltest.html.
Se avete installato tutto con make all come menzionato nella sezione precedente, i documenti saranno nella directory che avete specificato come WEBDIR nel Makefile.
Se non lo avete fatto, potrete lanciare make test per costruirli da javacgitest.html-dist, javaemailtest.html-dist e
javahtmltest.html-dist.
Quando siete sicuri che la vostra installazione sia andata a buon fine, potrete decidere se rimuovere CGI_Test.class, Email_Test.class
e
HTML_Test.class dalla
vostra directory JAVACGI e javacgitest.html,
javaemailtest.html e javahtmltest.html
dalla vostra directory WEBDIR visto che essi mostrano alcune informazioni relative all'utente che sono normalmente disponibili solo al server.
gzip -dc java_cgi-0.4.tgz | tar -xvf -(Se il numero della versione è cambiato, consultate le istruzioni contenute nella distribuzione per continuare l'installazione).
Makefile che troverete all'interno della directory java_cgi-0.4 appena creata e modificatelo opportunamente per il vostro sistema.make install.
Questo comando compilerà i programmi Java, applicherà le informazioni che avete specificato per il vostro sistema ed installerà tutti i file.
Se invece desiderate consultare la documentazione in formato HTML e visionare un documento HTML di test, lanciate make all.Esistono due problemi principali nel lanciare un programma Java da un server Web:
Bisogna lanciare l'interprete run-time di Java e fornire la classe iniziale (programma da eseguire) in linea di comando. Con un form HTML, non esiste nessuna precauzione nell'inviare una linea di comando al server web.
Ogni variabile d'ambiente necessaria al programma Java deve essere passata esplicitamente.
Non esiste un metodo simile alla funzione C getenv().
Per eliminare questi ostacoli, ho scritto un programma CGI di shell che fornisce le informazioni necessarie all'interprete Java.
Questo script di shell si occupa dell'interazione tra il demone HTTP daemon e il programma Java CGI che dovete usare. Estrae il nome del programma che volete lanciare dai dati forniti al server e raccoglie tutti i dati d'ambiente in un file temporaneo. Quindi lancia l'interprete run-time di Java con il nome del file di informazioni d'ambiente e il nome del programma aggiunto alla linea di comando.
La spiegazione di come viene configurato ed installato lo script java.cgi si trova nella sezione
Le Directory di Installazione.
I forms che usano i programmi Java CGI specificano delle azioni come di seguito formalizzato:
<form action="/cgi-bin/java.cgi/CGI_Test" method="POST">Dove
/cgi-bin/ è la directory locale che avete
specificato per i file binari CGI, java.cgi è il
front-end di Java che permette di lanciare programmi Java sul Web e
CGI_Test è un esempio del nome del programma
Java da lanciare.
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().
Usato quando conosciamo quanto spazio necessita al messaggio per essere allocato.
Aggiunge una lista di destinazioni primarie al messaggio e-mail.
Aggiunge una destinazione Carbon-Copy al messaggio e-mail.
Aggiunge una lista di destinazioni Carbon-Copy al messaggio e-mail.
Aggiunge una destinazione Blind Carbon-Copy al messaggio e-mail.
Aggiunge una lista di destinazioni Blind Carbon-Copy al messaggio e-mail.
Usato quando conosciamo quanto spazio necessita al messaggio per essere allocato.
Avvia una lista non-ordinata.
Avvia una lista ordinata.
Avvia una lista di directory.
Avvia una lista di menu.
Specifica un anchor.
Specifica un link.
Specifica un link ad un applet.
Makefile.Test, con la quale utilizzare ogni metodo di questo pacchetto.CGI_Test, Email_Test e
HTML_Test facciano affidamento l'uno sull'altro per fornire tests incrementali per obiettivi di debugging.
Orbits.net.*, la classe di supporto Text è in Orbits.text.Text.CGItest in CGI_Test.Email_Test.
CGI e java.cgi sono state modificate.javacgitest.html diventa parte della distribuzione.make durante
l'installazione vengono forniti con nomi che terminano con
-dist.