サーブレット API のパッケージ

サーブレット API は、Sun Microsystems の Java Software Division によって公開された仕様です。この仕様には、Java サーブレット、および Java サーブレットをサポートするサーバーによって要求されるクラス、メソッド、および動作の概要が記載されています。JRun Version 3.0 は、Java サーブレット API バージョン 2.2 の仕様をサポートしています。

サーブレット API には、次のパッケージが含まれています。

javax.servlet
javax.servlet.http

メモ

これらのパッケージに関する JavaDoc 形式のドキュメントが JRun の JRun のインストールディレクトリ/docs/api ディレクトリにあります。サーブレット API に関するその他のマニュアルについては、http://java.sun.com/products/servlet/ にアクセスしてください。

javax.servlet

javax.servlet パッケージには、次の表に示すように、すべてのサーブレットに適用されるインターフェイス、クラス、および例外が含まれています。

javax.servlet インターフェイス

次の表は、javax.servlet に含まれるインターフェイスの概要を示しています。

インターフェイス

説明

RequestDispatcher
要求の処理を、ほかのサーブレット、JSP、または HTML ファイルに転送するオブジェクトを定義します。また、応答にほかのサーブレットの出力を含めることもできます。

Servlet
サーブレットインスタンスを初期化して要求を処理し、サーブレットインスタンスを破棄するメソッドを定義します。GenericServlet クラスはこのインターフェイスを実装します。

ServletConfig
サーブレットの init メソッドに情報を渡すオブジェクトを定義します。名前/値ペア、サーブレットの名前、Web アプリケーションの ServletContext オブジェクトの参照が含まれています。

ServletContext
サーブレットがサーブレットコンテナに関する情報にアクセスするために使用するメソッドを定義します。また、アプリケーションの init パラメータが含まれています。1 台の仮想マシン上の Web アプリケーションごとに 1 つの
ServletContext があります。

ServletRequest
クライアント要求の情報をカプセル化するオブジェクトを定義します。各インスタンスには、名前/値ペア、属性、および入力ストリームが含まれています。

ServletResponse
クライアントに返す情報をカプセル化するオブジェクトを定義します。バイナリデータまたは文字データを送信できます。

SingleThreadModel
各サーブレットインスタンスに一度に 1 つの要求だけを実行させるオブジェクトを定義します。このインターフェイスの詳細については、JavaDoc API のマニュアルを参照してください。

インターフェイス	説明
RequestDispatcher	要求の処理を、ほかのサーブレット、JSP、または HTML ファイルに転送するオブジェクトを定義します。また、応答にほかのサーブレットの出力を含めることもできます。
Servlet	サーブレットインスタンスを初期化して要求を処理し、サーブレットインスタンスを破棄するメソッドを定義します。`GenericServlet` クラスはこのインターフェイスを実装します。
ServletConfig	サーブレットの `init` メソッドに情報を渡すオブジェクトを定義します。名前/値ペア、サーブレットの名前、Web アプリケーションの `ServletContext` オブジェクトの参照が含まれています。
ServletContext	サーブレットがサーブレットコンテナに関する情報にアクセスするために使用するメソッドを定義します。また、アプリケーションの init パラメータが含まれています。1 台の仮想マシン上の Web アプリケーションごとに 1 つの `ServletContext` があります。
ServletRequest	クライアント要求の情報をカプセル化するオブジェクトを定義します。各インスタンスには、名前/値ペア、属性、および入力ストリームが含まれています。
ServletResponse	クライアントに返す情報をカプセル化するオブジェクトを定義します。バイナリデータまたは文字データを送信できます。
SingleThreadModel	各サーブレットインスタンスに一度に 1 つの要求だけを実行させるオブジェクトを定義します。このインターフェイスの詳細については、JavaDoc API のマニュアルを参照してください。

javax.servlet クラス

次の表は、javax.servlet に含まれるクラスの概要を示しています。

クラス

説明

GenericServlet
プロトコルに依存しないサーブレット。通常はこのクラスではなくHttpServlet を使用します。

ServletInputStream
クライアント要求からバイナリデータを読み込むためのストリーム。通常、このクラスは使用しません。

ServletOutputStream
クライアントにバイナリデータを送信するためのストリーム。通常、このクラスは使用しません。

クラス	説明
GenericServlet	プロトコルに依存しないサーブレット。通常はこのクラスではなく`HttpServlet` を使用します。
ServletInputStream	クライアント要求からバイナリデータを読み込むためのストリーム。通常、このクラスは使用しません。
ServletOutputStream	クライアントにバイナリデータを送信するためのストリーム。通常、このクラスは使用しません。

javax.servlet 例外

次の表は、javax.servlet に含まれる例外の概要を示しています。

例外

説明

ServletException
サーブレットの問題を知らせる一般的な例外

UnavailableException
サーブレットが使用可能でないことを示します。この例外は、一時的または永久的に使用不能であることを示すために使用できます。

例外	説明
ServletException	サーブレットの問題を知らせる一般的な例外
UnavailableException	サーブレットが使用可能でないことを示します。この例外は、一時的または永久的に使用不能であることを示すために使用できます。

javax.servlet.http

javax.servlet.http パッケージには、HTTP の機能を要求するサーブレットに適用されるインターフェイスおよびクラスが含まれています。次の表では、これらについて説明します。

javax.servlet.http インターフェイス

次の表は、javax.servlet.http に含まれるインターフェイスの概要を示します。

インターフェイス

説明

HttpServletRequest
ServletRequest を HTTP サーブレット用に拡張します。このオブジェクトは、要求についてクッキー、属性、およびその他の情報にアクセスするために使用します。

HttpServletResponse
ServletResponse を HTTP サーブレット用に拡張します。
このオブジェクトは、ブラウザに応答を送信するために使用します。

HttpSession
複数のページ要求の間で保持されるユーザ情報が含まれています。セッションはセッション ID をキーとして識別され、セッション ID はクッキーまたは URL パラメーターに保存されます。

HttpSessionBinding Listener
オブジェクトがセッションからバインドされたとき、またはバインドを解除されたときに、オブジェクトにそのことを知らせます。このインターフェイスは、セッション固有のリソースを初期化およびクリーンアップするために使用します。

インターフェイス	説明
HttpServletRequest	`ServletRequest` を HTTP サーブレット用に拡張します。このオブジェクトは、要求についてクッキー、属性、およびその他の情報にアクセスするために使用します。
HttpServletResponse	`ServletResponse` を HTTP サーブレット用に拡張します。このオブジェクトは、ブラウザに応答を送信するために使用します。
HttpSession	複数のページ要求の間で保持されるユーザ情報が含まれています。セッションはセッション ID をキーとして識別され、セッション ID はクッキーまたは URL パラメーターに保存されます。
HttpSessionBinding Listener	オブジェクトがセッションからバインドされたとき、またはバインドを解除されたときに、オブジェクトにそのことを知らせます。このインターフェイスは、セッション固有のリソースを初期化およびクリーンアップするために使用します。

javax.servlet.http クラス

次の表は、javax.servlet.http に含まれるクラスの概要を示しています。

クラス

説明

Cookie
サーブレットをクライアントクッキーの作成、読み取り、
および変更に使用します。クッキーを読み取るには、HttpServletRequest オブジェクトを使用します。クッキーを設定するには、HttpServletResponse オブジェクトを使用します。

HttpServlet
HTTP サーブレットを作成するために拡張する抽象クラス。このクラスをすべての Web 指向のサーブレットに使用します。

HttpSessionBindingEvent
HttpSessionBindingListener インターフェイスを実装しているオブジェクトがセッションからバインドまたはバインド解除されたときに、そのオブジェクトに渡されます。2 つのメソッド getName および getSession が含まれています。

HttpUtils
便利なユーティリティメソッドが含まれています。
getRequestURL、parsePostData、parseQueryString などのメソッドが含まれています。

JRun によるアプリケーションの開発
サーブレット API の基本情報

クラス	説明
Cookie	サーブレットをクライアントクッキーの作成、読み取り、および変更に使用します。クッキーを読み取るには、`HttpServletRequest` オブジェクトを使用します。クッキーを設定するには、`HttpServletResponse` オブジェクトを使用します。
HttpServlet	HTTP サーブレットを作成するために拡張する抽象クラス。このクラスをすべての Web 指向のサーブレットに使用します。
HttpSessionBindingEvent	`HttpSessionBindingListener` インターフェイスを実装しているオブジェクトがセッションからバインドまたはバインド解除されたときに、そのオブジェクトに渡されます。2 つのメソッド `getName` および `getSession` が含まれています。
HttpUtils	便利なユーティリティメソッドが含まれています。 `getRequestURL`、`parsePostData`、`parseQueryString` などのメソッドが含まれています。