Trois classes principales sont pour l'instant support�es : CGI, Email et HTML. Je pense y ajouter des classes capables de g�rer des entr�es et des sorties format�es en MIME (respectivement MIMEin & MIMEout).
Quelques classes de test et de support sont �galement disponibles :
CGI_Test,
Email_Test et
HTML_Test doivent permettre
de tester votre installation. Elles peuvent aussi servir de point de
d�part � vos propres programmes Java bas�s sur cette biblioth�que de
classes. La classe
Text est une superclasse
des classes Email et HTML.
public class CGI
La classe CGI d�tient les "informations SGI" : les valeurs
d'environnement initialis�es par le serveur Web ainsi que le nom et
la valeur issus du formulaire quand l'action submit est
s�lectionn�e. Toutes les informations sont stock�es dans un objet de
classe Properties.
Cette classe se trouve dans le package "Orbits.net".
CGI() // Constructeur. getNames() // Recupere la liste de noms. getValue() // Recupere la valeur a partir du nom.
CGI_Test.
Construit un objet contenant les donn�es CGI disponibles.
public CGI()
Lorsqu'un objet CGI est construit, toutes les informations CGI disponibles sont r�cup�r�es et stock�es dans le nouvel objet.
Dresse la liste des noms d�finis par le formulaire.
public Enumeration getNames ()
Fournit la liste compl�te des noms pour lesquels des valeurs correspondantes ont �t� d�finies.
Une Enumeration de tous les noms d�finis.
R�cup�re la valeur associ�e au nom sp�cifi�.
public String getValue ( String nom )
Cette m�thode fournit la correspondance entre les
noms et les valeurs envoy�es depuis un formulaire
HTML.
La cl� par laquelle les valeurs sont choisies.
Une String contenant la valeur.
Cette classe fournit � la fois un exemple d'utilisation de la classe CGI, et un programme de test, qu'on pourra utiliser pour confirmer que le package Java CGI fonctionne correctement.
main() // main() du programme
CGI.
Fournit une m�thode main().
public static void main( String argv[] )
Il s'agit du point d'entr�e d'un programme CGI qui ne fait rien � part retourner la liste des couples nom/valeur.
Arguments pass�s au programme par le script
java.cgi.
Non utilis� pour l'instant.
public class Email extends Text
Les messages sont construits au moyen des m�thodes add*() de
la classe Text et les m�thodes sp�cifiques au courrier
�lectronique fournies par cette classe. Une fois compos�, le message
est envoy� vers sa destination finale.
Cette classe se trouve dans le package "Orbits.net".
Email() // Constructeur send() // Envoie le message e-mail sendTo() // Ajoute une destination au message subject() // Initialise le champ Subject: du message
Email_Test, Text.
Construit un objet qui contiendra un message �lectronique.
public Email()
Cr�e un message vide qui sera rempli par les m�thodes Email.
Text.
Envoie le message e-mail.
public void send ()
Formatage et envoi du message. Si aucune adresse de destination n'a �t� pr�cis�e, ne fait rien.
Ajoute une destination pour ce message.
public String sendTo ( String adresse )
Ajoute adresse � la liste des
destinations pour cette m�thode. Il n'existe pas de limite a
priori pour le nombre de destinations d'un message e-mail. Je
suis s�r qu'avec une liste assez grande, on peut d�passer la taille
acceptable pour le Mail Transport Agent, voire la m�moire
disponible sur votre syst�me.
Une destination � laquelle envoyer ce message.
Initialise le sujet du message.
public void subject ( String sujet )
Cette m�thode remplit le champ
Subject: du message. Si elle est appel�e plusieurs fois,
le sujet utilis� sera le dernier demand�.
Le texte du champ Subject: du message.
Cette classe fournit � la fois un exemple d'utilisation de la classe
Email et un programme de test qu'on pourra utiliser pour
s'assurer que le package Java CGI fonctionne correctement.
main() // main() du programme
Email.
Fournit une m�thode main().
public static void main( String argv[] )
Il s'agit du point d'entr�e d'un programme CGI qui
retourne une liste des couples nom/valeur disponibles. Cette liste
sera �galement envoy�e � l'adresse sp�cifi�e dans la variable
Email.
Arguments pass�s au programme par le script
java.cgi. Non utilis� pour l'instant.
public class HTML extends Text
Les messages sont cr��s � l'aide des m�thodes add*() de la
classe Text et des m�thodes sp�cifique au HTML ajout�es par
cette classe. Une fois termin�, le message est envoy�.
Aucun test n'est effectu� pour l'instant pour s'asurer que les m�thodes de construction de liste sont utilis�es dans le bon ordre. C'est donc au programmeur de faire attention � ne pas violer la syntaxe HTML.
Cette classe se trouve dans le package "Orbits.net".
HTML() // Constructeur. author() // Initialise le nom de l'auteur du document. definitionList() // Cree une liste de definitions. definitionListTerm() // Ajoute un terme a la liste de definitions. endList() // Termine une liste. listItem() // Ajoute une entree a une liste. send() // Envoie le message HTML. title() // Initialise le titre du document.
HTML_Test, Text.
Construit un objet qui contiendra un message HTML.
public HTML()
Cr�e un message vide qui sera rempli par les m�thodes HTML.
Text.
Initialise le nom de l'auteur du document.
public void author ( String auteur )
Donne au document un nom d'auteur ayant pour
valeur author.
Texte � utiliser en tant que nom d'auteur du message.
title().
Cr�e une liste de d�finitions.
public void definitionList ()
Initialise une liste de d�finition. Une liste
de d�finitions est une liste sp�cialis�e telle que chaque
entr�e de la liste soit un terme suivi du texte
correspondant � la d�finition de ce terme. La cr�ation d'une liste
de d�finitions doit �tre suivie par celle d'au moins un couple
terme/texte, et d'un appel � la m�thode endList().
Notons que, pour le moment, les listes ne peuvent pas �tre
imbriqu�es.
definitionListTerm(), endList(),
listItem().
Ajoute un terme � la liste de d�finitions.
public void definitionListTerm ()
Ajoute un terme � la liste de d�finitions. Le texte
d�finissant le partie terme de l'entr�e courante de la liste devra
�tre ins�r� dans le message apr�s l'appel de cette m�thode, et
avant qu'une m�thode listItem correspondante soit appel�e.
definitionList(), listItem().
Termine une liste.
public void endList ()
Cette m�thode permet de clore une liste. Notons que, pour le moment, les listes ne peuvent pas �tre imbriqu�es.
definitionList().
Ajoute une entr�e � une liste.
public void listItem ()
public void listItem ( String article )
public boolean listItem ( String terme, String article )
Ajoute une entr�e � une liste. Si la premi�re
forme est utilis�e, le texte de l'article de liste courant devra
�tre ajout� au message apr�s l'appel de cette m�thode, et avant tout
autre appel � des m�thodes de liste. Dans la deuxi�me et troisi�me
forme, le texte
article est pass� comme param�tre � la m�thode, au lieu (ou
en plus) d'�tre ajout� au message. La troisi�me forme est sp�cifique
aux listes de d�finitions et fournit � la fois le terme et la
d�finition de l'entr�e de liste.
Le texte de cette entr�e de liste de d�finitions.
Le texte de la partie terme de cette entr�e de liste de d�finitions.
definitionList(),
definitionListTerm(),
endList().
Envoie le message HTML.
public void send ()
Envoie le message HTML.
Donne une valeur au titre du document.
public void title ( String titre )
Initialise le texte du titre du document.
Le texte du titre de ce message.
author().
Cette classe offre � la fois un exemple d'utilisation de la classe
HTML et un programme de test qui peu servir � s'assurer que
le package Java CGI fonctionne correctement.
main() // main() du programme.
HTML.
Fournit une m�thode main().
public static void main( String argv[] )
Il s'agit du point d'entr�e pour un programme CGI qui retourne une liste des couples nom/valeur d'un document HTML, chaque couple �tant un �l�ment d'une liste de d�finitions.
Arguments pass�s au programme par le script
java.cgi Non utilis� pour l'instant.
public abstract class Text
Cette classe est la superclasse des classes Email et
HTML. Les messages sont construits � l'aide des m�thodes de
cette classe, puis compl�t�s et format�s gr�ce aux m�thodes des
sous-classes.
Cette classe se trouve dans le package "Orbits.text".
Text() // Constructeur. add() // Ajoute du texte a cet objet. addLineBreak() // Ajoute une rupture de ligne. addParagraph() // Ajoute une rupture de paragraphe.
Email, HTML.
Ajoute du texte � cet article
public void add ( char ajout )
public void add ( String ajout )
public void add ( StringBuffer ajout )
Ajoute le texte ajout � la suite du
contenu de cet article.
Texte � ajouter.
addLineBreak(), addParagraph().
Force une rupture de ligne � cet endroit dans le texte.
public void addLineBreak ()
Ins�re une rupture de ligne dans le texte, � l'endroit du point courant.
add(), addParagraph().
D�bute un nouveau paragraphe.
public void add ()
D�bute un nouveau paragraphe � ce point du flot textuel.
add(), addLineBreak().
Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:15