Next Previous Contents

5. Menggunakan class Java CGI

Saat ini terdapat tiga kelas utama yang didukung -- CGI, Email dan HTML. Saya sedang mempertimbangkan untuk menambah class yang berkaitan dengan input dan output yang berformat MIME -- MIMEin & MIMEout.

Terdapat pula sedikit class pendukung dan percobaan. CGI_Test, Email_Test dan HTML_Test ditujukan agar digunakan untuk menguji instalasi program. Mereka dapat juga digunakan sebagai titik awal bagi program Java anda yang menggunakan pustaka class ini. Class Text adalah superclass bagi class-class Email dan HTML.

5.1 CGI

Sintaks Class


  public class CGI

Deskripsi Class

Class CGI berisi Informasi CGI -- variabel-variabel lingkungan yang diset oleh web server dan nama/nilai yang dikirim dari sebuah form ketika tindakan submit dipilih. Seluruh informasi disimpan dalam Properties obyek class.

Class ini terdapat dalam paket Orbits.net.

Ringkasan Anggota


          CGI()         //  Konstruktor.
          getNames()    //  Ambil daftar nama-nama.
          getValue()    //  Ambil nilai form dg menspesifikasikan nama.

Lihat Juga

CGI_Test.

CGI()

Kegunaan

Membangun sebuah obyek yang mengandung data CGI yang tersedia.

Sintaks


public CGI()

Deskripsi

Ketika sebuah obyek CGI dikonstruksi, seluruh informasi CGI yangtersedia ditaruh di penyimpanan lokal terhadap obyek baru.

getNames()

Kegunaan

Tampilkan nama-nama yang didefinisikan memiliki nilai terkait.

Sintaks


public Enumeration getKeys ()

Deskripsi

Memberikan daftar lengkap nama yang nilai korespondennya terdefinisi.

Hasil

Sebuah Enumerasi seluruh nama yang terdefinisikan.

getValue()

Kegunaan

Mengambil nilai yang sesuai dengan nama yang dispesifikasikan.

Sintaks


public String getValue ( String name )

Deskripsi

Metode ini menyediakan korespondensi antara nama dan nilai yang dikirim dari sebuah form HTML.

Parameter

name

Kunci untuk memilih nilai.

Hasil

Sebuah string berisi nilai.

5.2 CGI_Test

Class ini menyediakan sebuah contoh bagaimana menggunakan class CGI dan sebuah program percobaan yang dapat digunakan untuk mengkonfirmasi bahwa paket Java CGI berfungsi dengan benar.

Ringkasan Anggota


          main()      //  Program main().

Lihat Juga

CGI

main()

Kegunaan

Menyediakan metode main().

Sintaks


public static void main( String argv[] )

Deskripsi

Ini adalah titik masuk untuk program CGI yang tidak mengerjakan sesuatu namun mengembalikan sebuah daftar pasangan nama/nilai yang ada dan nilai mereka saat ini.

Parameter

argv[]

Argumen-argumen yang diberikan ke program oleh java.cgi script. Saat ini tidak digunakan.

5.3 Email

Sintaks Class


  public class Email extends Text

Deskripsi Class

Pesan-pesan dibangun dengan metode add*() class Text dan metode khusus email ditambahkan oleh class ini. Setelah selesai, pesan dikirimkan ke tujuannya.

Class ini terdapat dalam paket Orbits.net

Ringkasan Anggota


          Email()      //  Konstruktor.
          send()       //  Mengirim pesan email.
          sendTo()     //  Menambahkan tujuan ke pesan.
          subject()    //  Menset Subject: untuk pesan.

Lihat Juga

Email_Test, Text.

Email()

Kegunaan

Membangun sebuah obyek yang mengandung pesan email.

Sintaks


public Email()

Deskripsi

Menset pesan kosong untuk diselesaikan oleh metode-metode Email.

Lihat Juga

Text.

send()

Kegunaan

Mengirim pesan email.

Sintaks


public void send ()

Deskripsi

Memformat dan mengirim pesan. Jika belum ada alamat tujuan yang diset, tidak ada tindakan diambil.

sendTo()

Kegunaan

Menambahkan tujuan pesan.

Sintaks


public String sendTo ( String address )

Deskripsi

Menambah alamat ke daftar tujuan metode ini. Tidak ada batasan jumlah tujuan yang boleh dimiliki pesan email. Saya yakin bahwa jika anda membuat daftar yang cukup besar, anda dapat melampaui ukuran parameter daftar yang dapat diterima Mail Transfer Agent atau memakai seluruh memori anda.

Parameter

address

Sebuah tujuan untuk mengirimkan pesan.

subject()

Kegunaan

Menset subyek untuk pesan.

Sintaks


public void subject ( String subject )

Deskripsi

Metode ini menset teks untuk baris Subject email. Jika dipanggil lebih dari satu kali, subyek yang paling akhir disetlah yang digunakan.

Parameter

subject

Teks untuk baris Subject pesan.

5.4 Email_Test

Class ini menyediakan sebuah contoh bagaimana menggunakan class Email dan menguji program yang dapat digunakan untuk memastikan bahwa paket Java CGI berfungsi dengan benar.

Ringkasan Anggota


          main()      //  Program main().

Lihat Juga

Email.

main()

Kegunaan

Menyediakan metode main()

Sintaks


public static void main( String argv[] )

Deskripsi

Ini adalah titik awal untuk program CGI yang mengembalikan daftar pasangan nama/nilai yang ada dan nilainya saat ini. Ia juga akan mengirimkan daftar ini ke alamat yang dispesifikasikan dalam variabel Email.

Parameter

argv[]

Argumen-argumen yang diberikan kepada program oleh script java.cgi. Saat ini tidak digunakan.

5.5 HTML

Sintaks Class


  public class HTML extends Text

Deskripsi Class

Pesan-pesan dibangun dengan metode-metode add*() class Text dan metode-metode khusus HTML ditambahkan oleh class ini. Setelah selesai, pesan dikirimkan ke tujuannya.

Saat ini, tidak ada pemeriksaan kesalahan untuk memastikan bahwa metode- metode pembangun daftar digunakan dalam urutan yang benar, sehingga pemrogram harus bekerja keras agar tidak melanggar sintaks HTML.

Class ini ada dalam paket Orbits.net

Ringkasan Anggota


          HTML()                  //  Konstruktor.
          author()                //  Menset nama penulis dokumen.
          definitionList()        //  Memulai daftar definisi.
          definitionListTerm()    //  Menambah suatu hal ke daftar definisi.
          endList()               //  Mengakhiri sebuah daftar.
          listItem()              //  Menambah suatu item ke daftar.
          send()                  //  Mengirim pesan HTML.
          title()                 //  Menset teks untuk judul dokumen.

Lihat Juga

HTML_Test, Text.

HTML()

Kegunaan

Membangun sebuah obyek yang akan mengandung pesan HTML.

Sintaks


public HTML()

Deskripsi

Menset pesan kosong untuk diselesaikan oleh metode-metode HTML.

Lihat Juga

Text.

author()

Kegunaan

Menset nama penulis dokumen.

Sintaks


public void author ( String author )

Deskripsi

Menset nama penulis dokumen ke penulis.

Parameter

author

Teks untuk digunakan sebagai penulis pesan ini.

Lihat Juga

title().

definitionList()

Kegunaan

Memulai daftar definisi.

Sintaks


public void definitionList ()

Deskripsi

Memulai daftar definisi. Sebuah daftar definisi adalah daftar khusus sehingga setiap masukan dalam daftar adalah sebuah term yang diikuti oleh definisi teks untuk term tersebut. Awal daftar definisi diikuti oleh penciptaan (paling sedikit) satu pasangan term/teks dan sebuah panggilan ke metode endList(). Sebagai catatan, untuk saat ini, daftar tidak dapat dibuat bersarang.

Lihat Juga

definitionListTerm(), endList(), listItem().

definitionListTerm()

Kegunaan

Menambah sebuah term ke daftar definisi.

Sintaks


public void definitionListTerm ()

Deskripsi

Menambah sebuah term ke daftar definisi. Teks untuk bagian term masukan daftar saat ini ditambahkan ke pesan setelah metode ini dipanggil dan sebelum metode listItem yang terkait dipanggil.

Lihat Juga

definitionList(), listItem().

endList()

Kegunaan

Mengakhiri daftar.

Sintaks


public void endList ()

Deskripsi

Mengakhiri daftar. Metode ini menutup daftar. Sebagai catatan, untuk saat ini, daftar tidak dapat dibuat bersarang.

Lihat Juga

definitionList().

listItem()

Kegunaan

Menambah sebuah masukan ke daftar.

Sintaks


        public void listItem ()

        public void listItem ( String item )

        public boolean listItem ( String term, String item )
        

Deskripsi

Menambah sebuah masukan ke daftar. Jika bentuk pertama yang digunakan, teks untuk item daftar saat ini ditambahkan ke pesan setelah metode ini dipanggil dan sebelum metode-metode daftar lainnya dipanggil. Dalam bentuk kedua dan ketiga, teks item dispesifikasikan sebagai parameter metode daripada ditambahkan (atau sebagai tambahan) ke pesan. Bentuk ketiga adalah khusus untuk daftar definisi dan menyediakan term dan definisi masukan daftar.

Parameter-parameter

item

Teks untuk masukan daftar.

term

Teks untuk bagian definisi masukan daftar term.

Lihat Juga

definitionList(), definitionListTerm(), endList().

send()

Kegunaan

Mengirim pesan HTML.

Sintaks


public void send ()

Deskripsi

Mengirim pesan HTML.

title()

Kegunaan

Menset teks untuk judul dokumen.

Sintaks


public void title ( String title )

Deskripsi

Menset teks untuk judul dokumen.

Parameter

title

Teks untuk judul pesan.

Lihat Juga

author().

5.6 HTML_Test

Class ini menyediakan sebuah contoh bagaimana menggunakan class HTML dan sebuah program percobaan yang dapat digunakan untuk memastikan bahwa paket Java CGI telah berfungsi dengan benar.

Ringkasan Anggota


          main()      //  Program main().

Lihat Juga

HTML.

main()

Kegunaan

Menyediakan metode main().

Sintaks


public static void main( String argv[] )

Deskripsi

Ini adalah titik awal bagi program CGI yang mengembalikan daftarpasangan nama/nilai yang ada dalam dokumen HTML, dengan setiap pasangan nama/nilai ditampilkan dalam elemen daftar definisi.

Parameter

argv[]

Argumen-argumen yang diberikan ke program oleh script java.cgi. Saat ini tidak digunakan.

5.7 Text

Sintaks Class


  public abstract class Text

Deskripsi Class

Class ini merupakan superclass dari class Email dan HTML. Pesan-pesan dibangun dengan metode-metode dalam class ini dan diselesaikan serta diformat dengan metode-metode dalam subclass-subclass.

Class ini ada dalam paket Orbits.text.

Ringkasan Anggota


          Text()            //  Konstruktor.
          add()             //  Menambah teks ke obyek.
          addLineBreak()    //  Menambah ganti baris.
          addParagraph()    //  Menambah ganti paragraf.

Lihat Juga

Email, HTML.

add()

Kegunaan

Menambahkan teks ke item.

Sintaks


        public void add ( char addition )

        public void add ( String addition )

        public void add ( StringBuffer addition )
     

Deskripsi

Menambahkan addition ke isi item teks.

Parameter

addition

Teks yang akan ditambahkan ke item teks.

Lihat Juga

addLineBreak(), addParagraph().

addLineBreak()

Kegunaan

Memaksa penggantian baris pada titik ini dalam teks.

Sintaks


public void addLineBreak ()

Deskripsi

Menambahkan penggantian baris ke teks di lokasi saat ini.

Lihat Juga

add(), addParagraph().

addParagraph()

Kegunaan

Memulai paragraf baru.

Sintaks


public void add ()

Deskripsi

Memulai paragraf baru pada titik ini dalam aliran teks.

Lihat Juga

add(), addLineBreak().


Next Previous Contents