javax.servlet
クラス GenericServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet

すべての実装インタフェース:

Serializable, Servlet, ServletConfig

直系の既知のサブクラス:

HttpServlet

public abstract class GenericServlet

extends Object

implements Servlet, ServletConfig, Serializable

プロトコルに依存しない一般的なServletを定義しています。 Webサーバ上で使用するHTTP を扱うServletを記述するには、 このクラスではなく HttpServlet を継承します。

GenericServlet はServlet、 ServletConfig インタフェースを実装しています。 HttpServlet のような特定のプロトコルに特化したサブクラスを継承する方法が一般的ですが、 GenericServlet をServletが直接継承することもあります。

GenericServlet を使うと簡単にServletを記述できるようになります。このクラスはライフサイクルに関係するメソッドである init、destroy や ServletConfig インタフェースのメソッドについては簡易的な実装を提供しています。 また、GenericServlet はServletContext インタフェースで定義されている log メソッドの実装も提供しています。

プロトコルに依存しない一般的なServletを記述するには、 抽象メソッドのservice をオーバライドするだけです。

バージョン:

$Version$

作成者:

Various

関連項目:

直列化された形式

コンストラクタの概要

GenericServlet()
なにも実行しません。

メソッドの概要

void	destroy() Servletコンテナが呼び出すメソッドです。
String	getInitParameter(String name) name で指定された初期値を表すString を返します。
Enumeration	getInitParameterNames() ひとつのServletに設定されている初期値の名前を表す String オブジェクトの Enumeration を返します。
ServletConfig	getServletConfig() このServletの ServletConfig オブジェクトを返します。
ServletContext	getServletContext() このServletが動作しているServletContext への参照を返します。
String	getServletInfo() 作者、バージョン、著作権といったServletに関する情報を返します。
String	getServletName() このServletのインスタンスの名前を返します。
void	init() 利便性を考慮して提供されたメソッドです。
void	init(ServletConfig config) Servletコンテナが呼び出すメソッドです。
void	log(String msg) Servletのログファイルに指定したメッセージを出力します。
void	log(String message, Throwable t) 補足説明的なメッセージを出力しますが、Throwable 例外を与えられるスタックトレースもログファイルに出力します。
abstract void	service(ServletRequest req, ServletResponse res) Servlet コンテナが実行します。

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

GenericServlet

public GenericServlet()

なにも実行しません。Servletの初期化は常に init メソッドの中で行います。

メソッドの詳細

destroy

public void destroy()

Servletコンテナが呼び出すメソッドです。このServlet がサービス提供を停止するときに呼び出されます。Servlet.destroy() を参照してください。

定義:

インタフェース Servlet 内の destroy

getInitParameter

public String getInitParameter(String name)

name で指定された初期値を表すString を返します。 該当する初期値が無い場合はnull を返します。 ServletConfig.getInitParameter(java.lang.String) を参照してください。

このメソッドは利便性を考慮して提供されたものです。実際には、 各Servletが維持している ServletConfig オブジェクトから指定のパラメータ値を取得しています。

定義:

インタフェース ServletConfig 内の getInitParameter

パラメータ:

name - 初期値の名前を指定するString

戻り値:

String 初期値を表わすString

getInitParameterNames

public Enumeration getInitParameterNames()

ひとつのServletに設定されている初期値の名前を表す String オブジェクトの Enumeration を返します。 Servletに初期値が設定されていない場合は空の Enumeration を返します。 ServletConfig.getInitParameterNames() を参照してください。

このメソッドは利便性を考慮して提供されたものです。実際には、 各Servletが維持している ServletConfig オブジェクトからパラメータ名前を取得しています。

定義:

インタフェース ServletConfig 内の getInitParameterNames

戻り値:

Enumeration ひとつのServletに設定されている初期値の名前を表す String オブジェクトの列挙

getServletConfig

public ServletConfig getServletConfig()

このServletの ServletConfig オブジェクトを返します。

定義:

インタフェース Servlet 内の getServletConfig

戻り値:

ServletConfig このServletを初期化した ServletConfig オブジェクト

関連項目:

Servlet.init(javax.servlet.ServletConfig)

getServletContext

public ServletContext getServletContext()

このServletが動作しているServletContext への参照を返します。 ServletConfig.getServletContext() を参照してください。

このメソッドは利便性を考慮して提供されたものです。実際には、 各Servletが維持している ServletConfig オブジェクトからコンテキストを取得しています。

定義:

インタフェース ServletConfig 内の getServletContext

戻り値:

ServletContext init メソッドの実行によりこの Servletに渡される ServletContext オブジェクト

関連項目:

ServletContext

getServletInfo

public String getServletInfo()

作者、バージョン、著作権といったServletに関する情報を返します。 デフォルトではこのメソッドは空の文字列を返すだけです。 このメソッドをオーバライドして意味のある値が返るようにしてください。 Servlet.getServletInfo() を参照してください。

定義:

インタフェース Servlet 内の getServletInfo

戻り値:

String このServlet関する情報。 デフォルトでは空文字列

init

public void init(ServletConfig config)
          throws ServletException

Servletコンテナが呼び出すメソッドです。 このServletがサービスを開始できる状態になったことを示します。 Servlet.init(javax.servlet.ServletConfig) を参照してください。

このメソッドの実装はServletConfigのオブジェクトを Servletコンテナから受け取り、クラス内部に維持し、 必要なときに使えるようにしています。このメソッドをオーバライドする場合は、 super.init(config) を呼び出さなければいけません。

定義:

インタフェース Servlet 内の init

パラメータ:

config - このServlet設定情報を含んでいる ServletConfig オブジェクト

例外:

ServletException - Servletの正常な処理が妨げられた場合に発生する例外

関連項目:

UnavailableException

init

public void init()
          throws ServletException

利便性を考慮して提供されたメソッドです。このメソッドをオーバライドすれば super.init(config) を実行する必要はありません。

init(ServletConfig) をオーバライドせずに、このメソッドをオーバライドすれば自動的に GenericServlet.init(ServletConfig config) から呼び出されます。 ServletConfig オブジェクトは getServletConfig() メソッドを実行することで取得できます。

例外:

ServletException - Servletの正常な処理が妨げられた場合に発生する例外

log

public void log(String msg)

Servletのログファイルに指定したメッセージを出力します。 Servletの名前がメッセージの前に追加されます。 ServletContext.log(String) を参照してください。

パラメータ:

msg - ログファイルに出力するメッセージを指定する String オブジェクト

log

public void log(String message,
                Throwable t)

補足説明的なメッセージを出力しますが、Throwable 例外を与えられるスタックトレースもログファイルに出力します。 このとき Servlet の名前がメッセージの前に追加されます。 ServletContext.log(String, Throwable) を参照してください。

パラメータ:

message - エラーや例外の説明するString

t - java.lang.Throwable型の エラー、あるいは例外

service

public abstract void service(ServletRequest req,
                             ServletResponse res)
                      throws ServletException,
                             IOException

Servlet コンテナが実行します。このメソッドによりServletがリクエストに対する応答を返します。 Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse) を 参照してください。

このメソッドはアブストラクト宣言されています。 HttpServlet などのサブクラスでオーバライドしなければなりません。

定義:

インタフェース Servlet 内の service

パラメータ:

req - クライアントのリクエストを表している ServletRequest オブジェクト

res - Servletからのレスポンスになる ServletResponse オブジェクト

例外:

ServletException - Servletの正常な処理が妨げられた場合に発生する例外

IOException - 入出力関連処理で発生する例外

getServletName

public String getServletName()

このServletのインスタンスの名前を返します。 ServletConfig.getServletName() を参照してください。

定義:

インタフェース ServletConfig 内の getServletName

戻り値:

このServletインスタンスの名前