|
Mergedoc Translation |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjavax.servlet.GenericServlet
public abstract class GenericServlet
プロトコルに依存しない一般的な Servlet を定義しています。
Web サーバ上で使用する HTTP を扱う Servlet を記述するには、このクラスではなく HttpServlet
を継承します。
GenericServlet
は Servlet
、ServletConfig
インタフェースを実装しています。
HttpServlet
のような特定のプロトコルに特化したサブクラスを継承する方法が一般的ですが、GenericServlet
を Servlet が直接継承することもあります。
GenericServlet
を使うと簡単に Servlet を記述できるようになります。
このクラスはライフサイクルに関係するメソッドである init
、destroy
や ServletConfig
インタフェースのメソッドについては簡易的な実装を提供しています。
また、GenericServlet
は ServletContext
インタフェースで定義されている log
メソッドの実装も提供しています。
プロトコルに依存しない一般的な Servlet を記述するには、抽象メソッドの service
をオーバライドするだけです。
コンストラクタの概要 | |
---|---|
GenericServlet()
なにも実行しません。 |
メソッドの概要 | |
---|---|
void |
destroy()
Servlet コンテナが呼び出すメソッドです。 |
java.lang.String |
getInitParameter(java.lang.String name)
name で指定された初期値を表す String を返します。 |
java.util.Enumeration |
getInitParameterNames()
ひとつの Servlet に設定されている初期値の名前を表す String オブジェクトの Enumeration を返します。 |
ServletConfig |
getServletConfig()
この Servlet の ServletConfig オブジェクトを返します。 |
ServletContext |
getServletContext()
この Servlet が動作している ServletContext への参照を返します。 |
java.lang.String |
getServletInfo()
作者、バージョン、著作権といった Servlet に関する情報を返します。 |
java.lang.String |
getServletName()
この Servlet のインスタンスの名前を返します。 |
void |
init()
利便性を考慮して提供されたメソッドです。 |
void |
init(ServletConfig config)
Servlet コンテナが呼び出すメソッドです。 |
void |
log(java.lang.String msg)
Servlet のログファイルに指定したメッセージを出力します。 |
void |
log(java.lang.String message,
java.lang.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 |
コンストラクタの詳細 |
---|
public GenericServlet()
init
メソッドの中で行います。
メソッドの詳細 |
---|
public void destroy()
Servlet.destroy()
を参照してください。
Servlet
内の destroy
public java.lang.String getInitParameter(java.lang.String name)
String
を返します。
該当する初期値が無い場合は null
を返します。
ServletConfig.getInitParameter(java.lang.String)
を参照してください。
このメソッドは利便性を考慮して提供されたものです。
実際には、各 Servlet が維持している ServletConfig
オブジェクトから指定のパラメータ値を取得しています。
ServletConfig
内の getInitParameter
name
- 初期値の名前を指定する String
String
public java.util.Enumeration getInitParameterNames()
String
オブジェクトの Enumeration
を返します。
Servlet に初期値が設定されていない場合は空の Enumeration
を返します。
ServletConfig.getInitParameterNames()
を参照してください。
このメソッドは利便性を考慮して提供されたものです。
実際には、各 Servlet が維持している ServletConfig
オブジェクトからパラメータ名前を取得しています。
ServletConfig
内の getInitParameterNames
String
オブジェクトの列挙public ServletConfig getServletConfig()
ServletConfig
オブジェクトを返します。
Servlet
内の getServletConfig
ServletConfig
オブジェクトServlet.init(javax.servlet.ServletConfig)
public ServletContext getServletContext()
ServletContext
への参照を返します。
ServletConfig.getServletContext()
を参照してください。
このメソッドは利便性を考慮して提供されたものです。
実際には、各 Servlet が維持している ServletConfig
オブジェクトからコンテキストを取得しています。
ServletConfig
内の getServletContext
init
メソッドの実行によりこの Servlet に渡される ServletContext
オブジェクトServletContext
public java.lang.String getServletInfo()
Servlet.getServletInfo()
を参照してください。
Servlet
内の getServletInfo
public void init(ServletConfig config) throws ServletException
Servlet.init(javax.servlet.ServletConfig)
を参照してください。
このメソッドの実装は ServletConfig
のオブジェクトを Servlet コンテナから受け取り、クラス内部に維持し、必要なときに使えるようにしています。
このメソッドをオーバライドする場合は、super.init(config)
を呼び出さなければいけません。
Servlet
内の init
config
- この Servlet 設定情報を含んでいる ServletConfig
オブジェクト
ServletException
- Servlet の正常な処理が妨げられた場合に発生する例外UnavailableException
public void init() throws ServletException
super.init(config)
を実行する必要はありません。
init(ServletConfig)
をオーバライドせずに、このメソッドをオーバライドすれば自動的に GenericServlet.init(ServletConfig config)
から呼び出されます。
ServletConfig
オブジェクトは getServletConfig()
メソッドを実行することで取得できます。
ServletException
- Servlet の正常な処理が妨げられた場合に発生する例外public void log(java.lang.String msg)
ServletContext.log(String)
を参照してください。
msg
- ログファイルに出力するメッセージを指定する String
オブジェクトpublic void log(java.lang.String message, java.lang.Throwable t)
Throwable
例外を与えられるスタックトレースもログファイルに出力します。
このとき Servlet の名前がメッセージの前に追加されます。
ServletContext.log(String, Throwable)
を参照してください。
message
- エラーや例外の説明する String
t
- java.lang.Throwable
型のエラー、あるいは例外public abstract void service(ServletRequest req, ServletResponse res) throws ServletException, java.io.IOException
Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
を参照してください。
このメソッドは abstract 宣言されています。
HttpServlet
などのサブクラスでオーバライドしなければなりません。
Servlet
内の service
req
- クライアントのリクエストを表している ServletRequest
オブジェクトres
- Servlet からのレスポンスになる ServletResponse
オブジェクト
ServletException
- Servlet の正常な処理が妨げられた場合に発生する例外
java.io.IOException
- 入出力関連処理で発生する例外public java.lang.String getServletName()
ServletConfig.getServletName()
を参照してください。
ServletConfig
内の getServletName
|
Mergedoc Translation |
||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |