/usr/share/doc/HOWTO/fr-html/Java-CGI-HOWTO.html is in doc-linux-fr-html 2013.01-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org">
<meta name="GENERATOR" content="LinuxDoc-Tools 0.9.69">
<title>Java CGI HOWTO</title>
</head>
<body>
<h1>Java CGI HOWTO</h1>
<h2>David H. Silber <code><a href=
"mailto:dhs@orbits.com">dhs@orbits.com</a></code>.</h2>
v0.4, 18 Novembre 1996.
<hr>
<em>Ce document vous explique comment convaincre votre serveur WWW
d'utiliser des programmes de CGI écrits en Java, et montre
l'emploi de Java dans l'écriture de programmes de CGI. Bien
que les HOWTO se restreignent en principe au système Linux,
celui-ci est indépendant de la version d'Unix
utilisée. <em>Traduction : <a href=
"mailto://xavier@oreilly.com">Xavier Cazin</a>, le 27 novembre
1997</em>.</em>
<hr>
<h2><a name="s1">1. Introduction</a></h2>
<p>Par construction du language, les variables d'environnement du
système ne sont pas facilement accessibles au programmeur
Java. Par ailleurs, le JDK (Java Development Kit) rend impossible
l'invocation directe d'un programme, ce qui ne facilite pas le
traitement standard par CGI des formulaires HTML. On peut
contourner ces limitations de plusieurs façons. Vous saurez
comment j'ai implémenté l'une d'elles en poursuivant
votre lecture.</p>
<h2><a name="ss1.1">1.1 Pré-requis</a></h2>
<p>Je considère que vous êtes familiarisé avec
les principes qui sous-tendent HTML et CGI, et que vous
possédez un minimum de connaissances de votre serveur HTTP.
La programmation Java ne devra pas non plus vous être
étrangère, à défaut de quoi ce qui va
suivre ne vous sera pas très parlant.</p>
<h2><a name="ss1.2">1.2 Ce document</a></h2>
<p><a href=
"http://www.orbits.com/software/Java_CGI.html">http://www.orbits.com/software/Java_CGI.html</a>
est l'adresse où vous êtes sûr de trouver la
dernière version de ce document.</p>
<h2><a name="ss1.3">1.3 Le package lui-même</a></h2>
<p>L'archive <a href=
"ftp://ftp.orbits.com/pub/software/java_cgi-0.4.tgz">ftp://ftp.orbits.com/pub/software/java_cgi-0.4.tgz</a>
contient la dernière version du package décrit ici.
Vous y trouverez également le source SGML de ce document (en
anglais bien sûr).</p>
<p>La distribution du package suit les recommandations de la LGPL
(GNU Library General Public License). Ce document peut être
distribué selon les termes gouvernant le copyright des Linux
HOWTO.</p>
<p>Merci de bien vouloir mentionner le document <a href=
"http://www.orbits.com/software/Java_CGI.html">http://www.orbits.com/software/Java_CGI.html</a>
si vous utilisez ce logiciel. Vous permettrez ainsi à
d'autres d'accéder aux classes Java CGI.</p>
<h2><a name="ss1.4">1.4 Publicité gratuite</a></h2>
<p>Ce document a été mis au point avec la
bienveillance de <b>Stellar Orbits Technology Services</b>. Si vous
voulez savoir ce que nous faisons, allez voir à <a href=
"http://www.orbits.com/">http://www.orbits.com/</a>.</p>
<h2><a name="install-long"></a> <a name="s2">2. Configuration de
votre serveur (avec explications)</a></h2>
<p>Cette section vous conduira à travers l'installation de
mon package <em>Java CGI</em>, et sera agrémentée
d'explications généreuses qui vous permettront de
mesurer les conséquences de vos actes. Si vous souhaitez
simplement installer les programmes, sans vous soucier du pourquoi
et du comment, sautez directement à la section <a href=
"#install-short">Configuration du serveur (version courte)</a>.</p>
<h2><a name="ss2.1">2.1 Contraintes logicielles et
matérielles</a></h2>
<p>Ce logiciel devrait fonctionner sur n'importe quel
système à la Unix sur lequel se trouvent au moins
installés le JDK et un serveur Web. J'utilise pour ma part
un <em>Linux Debian</em> sur lequel tourne le démon HTTP
<em>apache</em>. Si cela ne fonctionne pas sur votre installation,
n'hésitez pas à me contacter à <code><a href=
"mailto:dhs@orbits.com">dhs@orbits.com</a></code>.</p>
<p>Malheureusement, l'interpréteur Java n'est pas
particulièrement économe en mémoire ; si vous
devez utiliser souvent des programmes de CGI en Java, quelques
mégaoctets de RAM supplémentaires ne seront pas de
trop.</p>
<h2><a name="ss2.2">2.2 Java CGI</a></h2>
<p>Le logiciel que j'ai écrit s'appelle <em>Java CGI</em>
(Note: au cas où vous ne l'auriez pas encore remarqué
(NdT)). Vous pouvez le récupérer par ftp anonyme
à l'adresse <a href=
"ftp://www.orbits.com/pub/software/java_cgi-0.4.tgz">ftp://www.orbits.com/pub/software/java_cgi-0.4.tgz</a>.
(Le numéro de version peut avoir changé.)</p>
<h2><a name="ss2.3">2.3 Déploiement des sources</a></h2>
<p>Choisissez un répertoire où vous pourrez
tranquillement déployer l'archive du package. Je
suggère généralement
<code>/usr/local/src</code>. Désarchivez ensuite à
l'aide de la commande (Note : les "lignuxeurs"
préfèreront sans doute le plus élégant
<code>tar xzvf java_cgi-0.4.tgz</code> (NdT).) :</p>
<pre>
gzip -dc java_cgi-0.4.tgz | tar -xvf -
</pre>
Cela aura pour effet de créer un répertoire de nom
<code>java_cgi-0.4</code>. Vous y trouverez les fichiers auxquels
nous feront référence dans la suite. (Si le
numéro de version a changé, suivez les instructions
qui s'y trouvent à partir de maintenant).
<h2><a name="make-programs"></a> <a name="ss2.4">2.4 Chemins
locaux</a></h2>
<p>Vous allez devoir décider de l'endroit où vous
souhaitez que les programmes Java CGI résident. La plupart
du temps, vous aurez intérêt à les placer dans
un répertoire parallèle au répertoire
<code>cgi-bin</code>. La configuration de mon serveur
<em>apache</em> indiquait <code>/var/web/cgi-bin</code> comme
répertoire <code>cgi-bin</code> par défaut. J'ai donc
placé mes programmes Java CGI dans le répertoire
<code>/var/web/javacgi</code>. Il n'est pas conseillé de
placer ces programmes dans l'un des répertoires
référencés par <code>CLASSPATH</code>.
Éditez le Makefile pour refléter la configuration de
votre système. En tant qu'utilisateur root, lancez
<code>make install</code>. Cela aura pour effet de compiler vos
programmes Java, modifier le script <code>java.cgi</code> pour
qu'il s'adapte à votre système, et installer les
programmes au bon endroit. Si vous souhaitez également
disposer d'une version HTML de ce document, et d'un document test
en HTML, lancez plutôt <code>make all</code>.</p>
<h2><a name="install-test"></a> <a name="ss2.5">2.5 Test de votre
installation</a></h2>
<p>Les documents <code>javacgitest.html</code>,
<code>javaemailtest.html</code> et <code>javahtmltest.html</code>
devraient maintenant être installés. Si vous avez
choisi <code>make all</code>, ils se trouveront dans le
répertoire spécifié par la variable WEBDIR du
<code>Makefile</code>. Dans le cas contraire, vous pouvez lancer
<code>make test</code> pour les créer à partir de
<code>javacgitest.html-dist</code>,
<code>javaemailtest.html-dist</code> et
<code>javahtmltest.html-dist</code>.</p>
<p>Après vous être assuré que votre
installation s'était déroulée correctement,
vous pouvez supprimer les fichiers <code>CGI_Test.class</code>,
<code>Email_Test.class</code> et <code>HTML_Test.class</code> de
votre répertoire JAVACGI, ainsi que
<code>javacgitest.html</code>, <code>javaemailtest.html</code> et
<code>javahtmltest.html</code> de votre répertoire WEBDIR.
Ils montrent les informations utilisateurs auxquelles le serveur
est normalement seul à avoir accès.</p>
<h2><a name="install-short"></a> <a name="s3">3. Configuration du
serveur (version courte)</a></h2>
<ul>
<li>Récupérez le package <em>Java CGI</em> à
partir de <a href=
"ftp://www.orbits.com/pub/software/java_cgi-0.4.tgz">ftp://www.orbits.com/pub/software/java_cgi-0.4.tgz</a>.
(Le numéro de version peut avoir changé.)</li>
<li>Déployez la distribution à l'aide de la commande
<pre>
gzip -dc java_cgi-0.4.tgz | tar -xvf -
</pre>
(Si le numéro de version de la distribution a changé,
utilisez les instructions qui s'y trouvent à partir de
maintenant.)</li>
<li>Éditez le <code>Makefile</code> que vous trouverez dans
le nouveau répertoire <code>java_cgi-0.4</code> pour qu'il
reflète la configuration de votre système.</li>
<li>En tant que root, lancez <code>make install</code>. Cela aura
pour effet de compiler les programmes Java, prendre en compte les
informations propres à votre système, et installer
les divers fichiers.
<p>Si vous souhaitez disposer d'une version HTML de ce document,
ainsi que d'un document test en HTML, lancez plutôt
<code>make all</code>.</p>
</li>
<li>Vous devriez maintenant être paré.</li>
</ul>
<h2><a name="s4">4. Exécution d'un programme Java
CGI</a></h2>
<h2><a name="ss4.1">4.1 Difficultés d'exécution de
programmes Java avec le modèle CGI</a></h2>
<p>L'exécution d'un programme Java depuis un serveur Web
pose deux types de problèmes majeurs :</p>
<h3>Les programmes Java ne s'exécutent pas comme des
binaires ordinaires</h3>
<p>Il faut lancer l'interpréteur Java et fournir la classe
principale (le programme à exécuter) sur la ligne de
commande. Les formulaires HTML ne permettent pas d'envoyer
directement une ligne de commande au serveur Web.</p>
<h3>Java n'accède pas <em>a priori</em> aux variables
d'environnement</h3>
<p>Toutes les variables d'environnement requises par le programme
Java doivent lui être passées explicitement. Il
n'existe pas de méthode similaire à la fonction
<code>getenv()</code> de <b>C</b> .</p>
<h2><a name="ss4.2">4.2 Solutions proposées</a></h2>
<p>Pour contourner ces obstacles, j'ai écrit une script
shell de CGI, qui fournit les informations nécessaires
à l'interpréteur Java.</p>
<h3>Le script java.cgi</h3>
<p>Ce script de shell se charge de l'interaction entre le
démon HTTP et le programme Java CGI que vous souhaitez
utiliser. Il extrait le nom du programme que vous souhaitez lancer
à partir des données fournies par le serveur. Il
récupère ensuite toutes les valeurs d'environnement
dans un fichier temporaire. Enfin, il lance l'interpréteur
Java en lui passant le nom du fichier contenant les informations
d'environnement, ainsi que le nom du programme à
exécuter.</p>
<p>Le script <code>java.cgi</code> a été
configuré et installé selon les procédure
décrites à la section <a href="#make-programs">Decide
On Your Local Path Policies</a>.</p>
<h3>Invocation de java.cgi depuis un formulaire HTML</h3>
<p>Mes formulaires qui utilisent les programmes Java CGI
spécifient l'action à effectuer de la façon
suivante :</p>
<pre>
<form action="/cgi-bin/java.cgi/CGI_Test" method="POST">
</pre>
où <code>/cgi-bin/</code> est votre répertoire local
d'exécutables CGI, <code>java.cgi</code> est l'interface
permettant de lancer les programmes Java, et <code>CGI_Test</code>
est un exemple de programme Java à exécuter.
<h2><a name="s5">5. Utilisation des classes Java CGI</a></h2>
<p>Trois classes principales sont pour l'instant supportées
: <a href="#cgi-class">CGI</a>, <a href="#email-class">Email</a> et
<a href="#html-class">HTML</a>. Je pense y ajouter des classes
capables de gérer des entrées et des sorties
formatées en MIME (respectivement MIMEin & MIMEout).</p>
<p>Quelques classes de test et de support sont également
disponibles : <a href="#cgi-test-class">CGI_Test</a>, <a href=
"#email-test-class">Email_Test</a> et <a href=
"#email-test-class">HTML_Test</a> 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 <a href=
"#text-class">Text</a> est une superclasse des classes
<code>Email</code> et <code>HTML</code>.</p>
<h2><a name="cgi-class"></a> <a name="ss5.1">5.1 CGI</a></h2>
<h3>Syntaxe</h3>
<p><code>public class CGI</code></p>
<h3>Description</h3>
<p>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
<b>submit</b> est sélectionnée. Toutes les
informations sont stockées dans un objet de classe
<code>Properties</code>.</p>
<p>Cette classe se trouve dans le package "Orbits.net".</p>
<h3>Liste des membres</h3>
<hr>
<pre>
CGI() // Constructeur.
getNames() // Recupere la liste de noms.
getValue() // Recupere la valeur a partir du nom.
</pre>
<hr>
<h3>Voir aussi</h3>
<p><code>CGI_Test</code>.</p>
<h3>CGI()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Construit un objet contenant les données CGI
disponibles.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public CGI()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Lorsqu'un objet CGI est construit, toutes les informations CGI
disponibles sont récupérées et stockées
dans le nouvel objet.</p>
</dd>
</dl>
<h3>getNames()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Dresse la liste des noms définis par le formulaire.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public Enumeration getNames ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Fournit la liste complète des noms pour lesquels des
valeurs correspondantes ont été définies.</p>
</dd>
<dt><b>Retourne</b></dt>
<dd>
<p>Une <code>Enumeration</code> de tous les noms
définis.</p>
</dd>
</dl>
<h3>getValue()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Récupère la <b>valeur</b> associée au
<b>nom</b> spécifié.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public String getValue ( String nom )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Cette méthode fournit la correspondance entre les
<code>noms</code> et les <code>valeurs</code> envoyées
depuis un formulaire HTML.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>nom</b></dt>
<dd>
<p>La clé par laquelle les valeurs sont choisies.</p>
</dd>
</dl>
</dd>
<dt><b>Retourne</b></dt>
<dd>
<p>Une <code>String</code> contenant la valeur.</p>
</dd>
</dl>
<h2><a name="cgi-test-class"></a> <a name="ss5.2">5.2
CGI_Test</a></h2>
<p>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 <em>Java CGI</em> fonctionne
correctement.</p>
<h3>Liste des membres</h3>
<hr>
<pre>
main() // main() du programme
</pre>
<hr>
<h3>Voir aussi</h3>
<p><code>CGI</code>.</p>
<h3>main()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Fournit une méthode <code>main()</code>.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public static void main( String argv[] )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Il s'agit du point d'entrée d'un programme CGI qui ne
fait rien à part retourner la liste des couples
nom/valeur.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>argv[]</b></dt>
<dd>
<p>Arguments passés au programme par le script
<code>java.cgi</code>. Non utilisé pour l'instant.</p>
</dd>
</dl>
</dd>
</dl>
<h2><a name="email-class"></a> <a name="ss5.3">5.3 Email</a></h2>
<h3>Syntaxe</h3>
<p><code>public class Email extends Text</code></p>
<h3>Description</h3>
<p>Les messages sont construits au moyen des méthodes
<code>add*()</code> de la classe <code>Text</code> et les
méthodes spécifiques au courrier électronique
fournies par cette classe. Une fois composé, le message est
envoyé vers sa destination finale.</p>
<p>Cette classe se trouve dans le package "Orbits.net".</p>
<h3>Liste des membres</h3>
<hr>
<pre>
Email() // Constructeur
send() // Envoie le message e-mail
sendTo() // Ajoute une destination au message
subject() // Initialise le champ Subject: du message
</pre>
<hr>
<h3>Voir aussi</h3>
<p><code>Email_Test, Text</code>.</p>
<h3>Email()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Construit un objet qui contiendra un message
électronique.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public Email()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Crée un message vide qui sera rempli par les
méthodes Email.</p>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>Text</code>.</p>
</dd>
</dl>
<h3>send()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Envoie le message e-mail.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void send ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Formatage et envoi du message. Si aucune adresse de destination
n'a été précisée, ne fait rien.</p>
</dd>
</dl>
<h3>sendTo()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Ajoute une destination pour ce message.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public String sendTo ( String adresse )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Ajoute <code>adresse</code> à la liste des destinations
pour cette méthode. Il n'existe pas de limite <em>a
priori</em> 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 <em>Mail Transport
Agent</em>, voire la mémoire disponible sur votre
système.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>adresse</b></dt>
<dd>
<p>Une destination à laquelle envoyer ce message.</p>
</dd>
</dl>
</dd>
</dl>
<h3>subject()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Initialise le sujet du message.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void subject ( String sujet )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Cette méthode remplit le champ <code>Subject:</code> du
message. Si elle est appelée plusieurs fois, le sujet
utilisé sera le dernier demandé.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>sujet</b></dt>
<dd>
<p>Le texte du champ <code>Subject:</code> du message.</p>
</dd>
</dl>
</dd>
</dl>
<h2><a name="email-test-class"></a> <a name="ss5.4">5.4
Email_Test</a></h2>
<p>Cette classe fournit à la fois un exemple d'utilisation
de la classe <code>Email</code> et un programme de test qu'on
pourra utiliser pour s'assurer que le package <em>Java CGI</em>
fonctionne correctement.</p>
<h3>Liste des membres</h3>
<hr>
<pre>
main() // main() du programme
</pre>
<hr>
<h3>Voir aussi</h3>
<p><code>Email</code>.</p>
<h3>main()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Fournit une méthode <code>main()</code>.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public static void main( String argv[] )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>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 <code>Email</code>.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>argv[]</b></dt>
<dd>
<p>Arguments passés au programme par le script
<code>java.cgi</code>. Non utilisé pour l'instant.</p>
</dd>
</dl>
</dd>
</dl>
<h2><a name="html-class"></a> <a name="ss5.5">5.5 HTML</a></h2>
<h3>Syntaxe</h3>
<p><code>public class HTML extends Text</code></p>
<h3>Description</h3>
<p>Les messages sont créés à l'aide des
méthodes <code>add*()</code> de la classe <code>Text</code>
et des méthodes spécifique au HTML ajoutées
par cette classe. Une fois terminé, le message est
envoyé.</p>
<p>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.</p>
<p>Cette classe se trouve dans le package "Orbits.net".</p>
<h3>Liste des membres</h3>
<hr>
<pre>
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.
</pre>
<hr>
<h3>Voir aussi</h3>
<p><code>HTML_Test, Text</code>.</p>
<h3>HTML()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Construit un objet qui contiendra un message HTML.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public HTML()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Crée un message vide qui sera rempli par les
méthodes HTML.</p>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>Text</code>.</p>
</dd>
</dl>
<h3>author()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Initialise le nom de l'auteur du document.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void author ( String auteur )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Donne au document un nom d'auteur ayant pour valeur
<code>author</code>.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>auteur</b></dt>
<dd>
<p>Texte à utiliser en tant que nom d'auteur du message.</p>
</dd>
</dl>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>title()</code>.</p>
</dd>
</dl>
<h3>definitionList()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Crée une liste de définitions.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void definitionList ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Initialise une liste de définition. Une <em>liste de
définitions</em> est une liste spécialisée
telle que chaque entrée de la liste soit un <em>terme</em>
suivi du <em>texte</em> 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 <code>endList()</code>.
<em>Notons que, pour le moment, les listes ne peuvent pas
être imbriquées.</em></p>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>definitionListTerm()</code>, <code>endList()</code>,
<code>listItem()</code>.</p>
</dd>
</dl>
<h3>definitionListTerm()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Ajoute un terme à la liste de définitions.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void definitionListTerm ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>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 <code>listItem</code> correspondante soit
appelée.</p>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>definitionList()</code>, <code>listItem()</code>.</p>
</dd>
</dl>
<h3>endList()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Termine une liste.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void endList ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Cette méthode permet de clore une liste. <em>Notons que,
pour le moment, les listes ne peuvent pas être
imbriquées.</em></p>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>definitionList()</code>.</p>
</dd>
</dl>
<h3>listItem()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Ajoute une entrée à une liste.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void listItem ()</code></p>
</dd>
<dd>
<p><code>public void listItem ( String article )</code></p>
</dd>
<dd>
<p><code>public boolean listItem ( String terme, String article
)</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>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
<code>article</code> 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.</p>
</dd>
<dt><b>Paramètres</b></dt>
<dd>
<dl>
<dt><b>article</b></dt>
<dd>
<p>Le texte de cette entrée de liste de
définitions.</p>
</dd>
<dt><b>terme</b></dt>
<dd>
<p>Le texte de la partie terme de cette entrée de liste de
définitions.</p>
</dd>
</dl>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>definitionList()</code>,
<code>definitionListTerm()</code>, <code>endList()</code>.</p>
</dd>
</dl>
<h3>send()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Envoie le message HTML.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void send ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Envoie le message HTML.</p>
</dd>
</dl>
<h3>title()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Donne une valeur au titre du document.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void title ( String titre )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Initialise le texte du titre du document.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>titre</b></dt>
<dd>
<p>Le texte du titre de ce message.</p>
</dd>
</dl>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>author()</code>.</p>
</dd>
</dl>
<h2><a name="html-test-class"></a> <a name="ss5.6">5.6
HTML_Test</a></h2>
<p>Cette classe offre à la fois un exemple d'utilisation de
la classe <code>HTML</code> et un programme de test qui peu servir
à s'assurer que le package <em>Java CGI</em> fonctionne
correctement.</p>
<h3>Liste des membres</h3>
<hr>
<pre>
main() // main() du programme.
</pre>
<hr>
<h3>Voir aussi</h3>
<p><code>HTML</code>.</p>
<h3>main()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Fournit une méthode <code>main()</code>.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public static void main( String argv[] )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>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.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>argv[]</b></dt>
<dd>
<p>Arguments passés au programme par le script
<code>java.cgi</code> Non utilisé pour l'instant.</p>
</dd>
</dl>
</dd>
</dl>
<h2><a name="text-class"></a> <a name="ss5.7">5.7 Text</a></h2>
<h3>Syntaxe</h3>
<p><code>public abstract class Text</code></p>
<h3>Description</h3>
<p>Cette classe est la superclasse des classes <code>Email</code>
et <code>HTML</code>. 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.</p>
<p>Cette classe se trouve dans le package "Orbits.text".</p>
<h3>Liste des membres</h3>
<hr>
<pre>
Text() // Constructeur.
add() // Ajoute du texte a cet objet.
addLineBreak() // Ajoute une rupture de ligne.
addParagraph() // Ajoute une rupture de paragraphe.
</pre>
<hr>
<h3>Voir aussi</h3>
<p><code>Email</code>, <code>HTML</code>.</p>
<h3>add()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Ajoute du texte à cet article</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void add ( char ajout )</code></p>
</dd>
<dd>
<p><code>public void add ( String ajout )</code></p>
</dd>
<dd>
<p><code>public void add ( StringBuffer ajout )</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Ajoute le texte <code>ajout</code> à la suite du contenu
de cet article.</p>
</dd>
<dt><b>Paramètre</b></dt>
<dd>
<dl>
<dt><b>ajout</b></dt>
<dd>
<p>Texte à ajouter.</p>
</dd>
</dl>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>addLineBreak()</code>, <code>addParagraph()</code>.</p>
</dd>
</dl>
<h3>addLineBreak()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Force une rupture de ligne à cet endroit dans le
texte.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void addLineBreak ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Insère une rupture de ligne dans le texte, à
l'endroit du point courant.</p>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>add()</code>, <code>addParagraph()</code>.</p>
</dd>
</dl>
<h3>addParagraph()</h3>
<dl>
<dt><b>Finalité</b></dt>
<dd>
<p>Débute un nouveau paragraphe.</p>
</dd>
<dt><b>Syntaxe</b></dt>
<dd>
<p><code>public void add ()</code></p>
</dd>
<dt><b>Description</b></dt>
<dd>
<p>Débute un nouveau paragraphe à ce point du flot
textuel.</p>
</dd>
<dt><b>Voir aussi</b></dt>
<dd>
<p><code>add()</code>, <code>addLineBreak()</code>.</p>
</dd>
</dl>
<h2><a name="s6">6. Améliorations prévues</a></h2>
<ul>
<li>Ajouter à la classe Email :
<dl>
<dt><b>Email( int capacité )</b></dt>
<dd>
<p>Quand on connaît à l'avance l'espace à
alloué au message.</p>
</dd>
<dt><b>sendTo( String [] adresse )</b></dt>
<dd>
<p>Ajoute une liste de destinations principales (champ
<code>To:</code>) au message e-mail.</p>
</dd>
<dt><b>sendCc( String adresse )</b></dt>
<dd>
<p>Ajoute une destination au champ <code>Cc:</code> (Carbon-Copy)
du message e-mail.</p>
</dd>
<dt><b>sendCc( String [] address )</b></dt>
<dd>
<p>Ajoute une liste de destinations au champ <code>Cc:</code>
(Carbon-Copy) du message e-mail.</p>
</dd>
<dt><b>sendBcc( String adresse )</b></dt>
<dd>
<p>Ajoute une destination au champ <code>Bcc:</code> (Blind
Carbon-Copy) du message e-mail.</p>
</dd>
<dt><b>sendBcc( String [] adresse )</b></dt>
<dd>
<p>Ajoute une liste de destinations au champ <code>Bcc:</code>
(Blind Carbon-Copy) du message e-mail.</p>
</dd>
</dl>
</li>
<li>Ajouter à la classe HTML :
<dl>
<dt><b>HTML( int capacité )</b></dt>
<dd>
<p>Quand on connaît à l'avance l'espace à
alloué au message.</p>
</dd>
<dt><b>public void unorderedList()</b></dt>
<dd>
<p>Démarre une liste non ordonnée.</p>
</dd>
<dt><b>public void orderedList()</b></dt>
<dd>
<p>Démarre une liste ordonnée.</p>
</dd>
<dt><b>public void directoryList()</b></dt>
<dd>
<p>Démarre une liste de répertoires.</p>
</dd>
<dt><b>public void menuList()</b></dt>
<dd>
<p>Démarre une liste de menu.</p>
</dd>
<dt><b>void anchor( String anchorName )</b></dt>
<dd>
<p>Spécifie une ancre.</p>
</dd>
<dt><b>void link( String url, String text )</b></dt>
<dd>
<p>Spécifie un lien.</p>
</dd>
<dt><b>void applet( String url, String altText )</b></dt>
<dd>
<p>Spécifie un lien applet.</p>
</dd>
</dl>
</li>
<li>Autoriser l'imbrication des listes HTML.</li>
<li>Ajouter du code de gestion d'erreur pour s'assurer que le
formatage des listes HTML s'effectue dans le bon ordre.</li>
<li>L'emplacement du fichier des informations d'environnement devra
être configurable à partir du
<code>Makefile</code>.</li>
<li>Éliminer les couples nom/valeur vides qui apparaissent
dans la liste quand la méthode GET est utilisée pour
le transfert des données.</li>
<li>Réfléchir à un moyen d'implémenter
l'interface java.util.Enumeration avec CGI pour fournir des noms de
variables.</li>
<li>Ajouter une classe <code>Test</code>, qui permettrait
d'utiliser toutes les méthodes de ce package.</li>
<li>Documenter la manière dont <code>CGI_Test</code>,
<code>Email_Test</code> et <code>HTML_Test</code> se
réfèrent mutuellement pour fournir des tests
incrémentaux facilitant le débogage.</li>
<li>Documenter la manière dont Test se sert de toutes les
fonctionnalités présentes dans le package.</li>
</ul>
<h2><a name="s7">7. Modifications</a></h2>
<h2><a name="ss7.1">7.1 Modifications entre les versions 0.3 et
0.4</a></h2>
<ul>
<li>Développement de la classe HTML pour qu'elle fournisse
des fonctionnalités minimales.</li>
<li>Écriture de la classe HTML_Test et de
javahtmltest.html-dist.</li>
<li>Ajout des méthodes HTML gérant les listes de
définitions.</li>
</ul>
<h2><a name="ss7.2">7.2 Modifications entre les versions 0.2 et
0.3</a></h2>
<ul>
<li>Ajout des classes Text et Email. HTML a été
également ajouté, sans qu'il soit vraiment
utilisable.</li>
<li>Placement des diverses classes dans des packages. Les classes
principales se trouvent dans <code>Orbits.net.*</code>, la classe
de support <code>Text</code> se trouve dans
<code>Orbits.text.Text</code>.</li>
<li><code>CGItest</code> devient <code>CGI_Test</code>.</li>
<li>Ajout de la classe <code>Email_Test</code>.</li>
</ul>
<h2><a name="ss7.3">7.3 Modifications entre les versions 0.1 et
0.2</a></h2>
<ul>
<li>Les variables d'environnement sont placées dans un
fichier temporaire, au lieu d'être passées à
l'interpréteur Java sur la ligne de commande. La classe
<code>CGI</code> et le script <code>java.cgi</code> durent
être modifiés.</li>
<li>Le document <code>javacgitest.html</code> devient partie
intégrante de la distribution.</li>
<li>Les fichiers texte qui sont modifiés par
<code>make</code> lors de l'installation sont fournis avec des noms
terminés par <em>-dist</em>.</li>
</ul>
</body>
</html>
|