javax.servlet

クラス GenericServlet

java.lang.Object

javax.servlet.GenericServlet

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

Serializable, Servlet, ServletConfig

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

HttpServlet

public abstract class GenericServlet
extends Object
implements Servlet, ServletConfig, Serializable

総称的なプロトコルに依存しないサーブレットを定義します。 Webで使用するHTTPのサーブレットを作成したい場合は HttpServlet を継承してください。

GenericServlet は Servletと ServletConfig の二つのインターフェースを実装します。 GenericServlet を直接継承してもよいですが、HttpServlet などのプロトコルに依存したサブクラスを継承するのがより一般的です。

GenericServlet はサーブレットを簡単に作成できるようにします。 これはライフサイクルメソッドのうちinit と destroy の単純な(何もしない)バージョンと、 ServletConfig インターフェースのメソッドを提供します。 GenericServlet は ServletContext インターフェースに定義された log メソッドも実装しています。

GenericServlet を継承してサーブレットを作成する場合はabstractなserviceメソッドだけを実装する必要があります。

作成者:

Various

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
GenericServlet() 何もしません。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	destroy() サーブレットがサービスから取り除かれるときにサーブレットコンテナから呼び出されます。
String	getInitParameter(String name) 名前付き初期化パラメーターに含まれる値のStringを返します。
Enumeration<String>	getInitParameterNames() サーブレットの初期化パラメーターの名前をStringオブジェクトのEnumerationとして返します。
ServletConfig	getServletConfig() サーブレットの ServletConfig のオブジェクトを返します。
ServletContext	getServletContext() このサーブレットが動いているServletContextを返します。
String	getServletInfo() サーブレットの情報を返します。
String	getServletName() サーブレットのインスタンスの名前を返します。
void	init() super.init(config)を呼ばなくてもオーバーライドできるようにするための便利メソッドです。
void	init(ServletConfig config) サーブレットがサービスに組込まれるときにサーブレットコンテナに呼出されます。
void	log(String msg) 指定されたメッセージをサーブレットの名前を先頭に付けてログファイルに書き込みます。
void	log(String message, Throwable t) 指定されたメッセージとThrowableのスタックトレースをサーブレットの名前を先頭に付けてログファイルに書き込みます。
abstract void	service(ServletRequest req, ServletResponse res) サーブレットがリクエストに応答できるようにサーブレットコンテナによって呼び出されます。

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

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

コンストラクタの詳細

GenericServlet

public GenericServlet()

何もしません。サーブレットのすべての初期化は init メソッドで行われます。

メソッドの詳細

destroy

public void destroy()

サーブレットがサービスから取り除かれるときにサーブレットコンテナから呼び出されます。 Servlet.destroy() を参照してください。

定義:

destroy インタフェース内 Servlet

getInitParameter

public String getInitParameter(String name)

名前付き初期化パラメーターに含まれる値のStringを返します。 存在しない場合はnullを返します。 ServletConfig.getInitParameter(java.lang.String)を参照してください。

このメソッドは簡便さのために提供されています。 これはサーブレットの ServletConfig のオブジェクトから名前付きパラメーターを取得します。

定義:

getInitParameter インタフェース内 ServletConfig

パラメータ:

name - 初期化パラメータの名前を指定するString

戻り値:

String 初期化パラメータの値のString

getInitParameterNames

public Enumeration<String> getInitParameterNames()

サーブレットの初期化パラメーターの名前をStringオブジェクトのEnumerationとして返します。 サーブレットに初期化パラメーターがない場合は空のEnumerationを返します。 ServletConfig.getInitParameterNames()を参照してください。

このメソッドは簡便さのために提供されています。 これはサーブレットの ServletConfig のオブジェクトからパラメーター名を取得します。

定義:

getInitParameterNames インタフェース内 ServletConfig

戻り値:

Enumeration サーブレットの初期化パラメータの名前を含んだStringオブジェクトのEnumeration

getServletConfig

public ServletConfig getServletConfig()

サーブレットの ServletConfig のオブジェクトを返します。

定義:

getServletConfig インタフェース内 Servlet

戻り値:

ServletConfig このサーブレットが初期化された ServletConfig のオブジェクト

関連項目:

Servlet.init(javax.servlet.ServletConfig)

getServletContext

public ServletContext getServletContext()

このサーブレットが動いているServletContextを返します。 ServletConfig.getServletContext()を参照してください。

このメソッドは簡便さのために提供されています。 これはサーブレットの ServletConfig のオブジェクトからコンテキストを取得します。

定義:

getServletContext インタフェース内 ServletConfig

戻り値:

ServletContext initに渡された ServletContext のオブジェクト

関連項目:

ServletContext

getServletInfo

public String getServletInfo()

サーブレットの情報を返します。作者やバージョン、コピーライトなどです。 デフォルトでは空文字列を返します。 このメソッドをオーバーライドして意味のある値を返すようにします。 Servlet.getServletInfo()を参照してください。

定義:

getServletInfo インタフェース内 Servlet

戻り値:

String このサーブレットの説明、デフォルトでは空文字列

init

public void init(ServletConfig config)
          throws ServletException

サーブレットがサービスに組込まれるときにサーブレットコンテナに呼出されます。 Servlet.init(javax.servlet.ServletConfig)を参照してください。

この実装はサーブレットコンテナから受け取ったServletConfigオブジェクトをあとで使用するために格納します。 このメソッドの振る舞いをオーバーライドする場合は super.init(config) を呼び出してください。

定義:

init インタフェース内 Servlet

パラメータ:

config - このサーブレットの設定情報を含むServletConfig のオブジェクト

例外:

ServletException - サーブレットの通常の処理で例外が発生した

関連項目:

UnavailableException

init

public void init()
          throws ServletException

super.init(config)を呼ばなくてもオーバーライドできるようにするための便利メソッドです。

init(ServletConfig)をオーバーライドしなくても 単にこのメソッドをオーバーライドすれば GenericServlet.init(ServletConfig config) によって呼び出されます。 ServletConfig オブジェクトは から引き続き取得できます。

例外:

ServletException - サーブレットの通常の処理で例外が発生した

log

public void log(String msg)

指定されたメッセージをサーブレットの名前を先頭に付けてログファイルに書き込みます。 ServletContext.log(String) を参照してください。

パラメータ:

msg - ログファイルに書き込まれるメッセージ

log

public void log(String message,
                Throwable t)

指定されたメッセージとThrowableのスタックトレースをサーブレットの名前を先頭に付けてログファイルに書き込みます。 ServletContext.log(String, Throwable) を参照してください。

パラメータ:

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

t - java.lang.Throwable

service

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

サーブレットがリクエストに応答できるようにサーブレットコンテナによって呼び出されます。 Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse) を参照してください。

このメソッドはabstractで定義されているので、 HttpServletなどのサブクラスでオーバーライドする必要があります。

定義:

service インタフェース内 Servlet

パラメータ:

req - クライアントのリクエストが含まれるServletRequestのオブジェクト

res - サーブレットのレスポンスが含まれる ServletResponseのオブジェクト

例外:

ServletException - サーブレットの通常の処理で例外が発生した

IOException - I/Oの例外が発生した

getServletName

public String getServletName()

サーブレットのインスタンスの名前を返します。 ServletConfig.getServletName()を参照してください。

定義:

getServletName インタフェース内 ServletConfig

戻り値:

サーブレットのインスタンスの名前