パッケージ jakarta.servlet

クラス GenericServlet

  • 実装されたすべてのインターフェース:
    ServletServletConfigSerializableSE
    既知の直属サブクラス
    HttpServlet

    public abstract class GenericServlet
    extends ObjectSE
    implements Servlet, ServletConfig, SerializableSE
    汎用の、プロトコルに依存しないサーブレットを定義します。Web で使用する HTTP サーブレットを作成するには、代わりに HttpServlet を継承します。

    GenericServlet は、Servlet および ServletConfig インターフェースを実装します。GenericServlet はサーブレットによって直接拡張できますが、HttpServlet などのプロトコル固有のサブクラスを継承する方が一般的です。

    GenericServlet は、サーブレットの作成を容易にします。ライフサイクルメソッド init および destroy および ServletConfig インターフェースのメソッドの単純なバージョンを提供します。GenericServlet は、ServletContext インターフェースで宣言された log メソッドも実装します。

    汎用サーブレットを作成するには、抽象 service メソッドをオーバーライドするだけです。

    作成者:
    Various
    関連事項:
    直列化された形式
    • コンストラクターのサマリー

      コンストラクター  
      コンストラクター 説明
      GenericServlet()
      何もしません。
    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド   具象メソッド  
      修飾子と型 メソッド 説明
      voiddestroy()
      サーブレットコンテナーによって呼び出され、サーブレットがサービスを停止していることをサーブレットに示します。
      StringSEgetInitParameter​(StringSE name)
      指定された初期化パラメーターの値を含む String を返します。パラメーターが存在しない場合は null を返します。
      EnumerationSE<StringSE>getInitParameterNames()
      サーブレットの初期化パラメーターの名前を String オブジェクトの Enumeration として、またはサーブレットに初期化パラメーターがない場合は空の Enumeration を返します。
      ServletConfiggetServletConfig()
      このサーブレットの ServletConfig オブジェクトを返します。
      ServletContextgetServletContext()
      このサーブレットが実行されている ServletContext への参照を返します。
      StringSEgetServletInfo()
      作成者、バージョン、著作権など、サーブレットに関する情報を返します。
      StringSEgetServletName()
      このサーブレットインスタンスの名前を返します。
      voidinit()
      super.init(config) を呼び出す必要がないようにオーバーライドできる便利なメソッド。
      voidinit​(ServletConfig config)
      サーブレットがサービスに配置されていることをサーブレットに示すために、サーブレットコンテナーによって呼び出されます。
      voidlog​(StringSE msg)
      サーブレットの名前を前に付けて、指定されたメッセージをサーブレットログファイルに書き込みます。
      voidlog​(StringSE message, ThrowableSE t)
      特定の Throwable 例外の説明メッセージとスタックトレースをサーブレットログファイルに書き込み、サーブレット名を前に付けます。
      abstract voidservice​(ServletRequest req, ServletResponse res)
      サーブレットがリクエストに応答できるようにするために、サーブレットコンテナーによって呼び出されます。
    • コンストラクターの詳細

      • GenericServlet

        public GenericServlet()
        何もしません。サーブレットの初期化はすべて、init メソッドの 1 つによって行われます。
    • メソッドの詳細

      • destroy

        public void destroy()
        サーブレットコンテナーによって呼び出され、サーブレットがサービスを停止していることをサーブレットに示します。Servlet.destroy() を参照してください。
        次で指定:
        インターフェース Servletdestroy 
      • getInitParameter

        public StringSE getInitParameter​(StringSE name)
        指定された初期化パラメーターの値を含む String を返します。パラメーターが存在しない場合は null を返します。ServletConfig.getInitParameter(java.lang.String) を参照してください。

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

        次で指定:
        インターフェース ServletConfiggetInitParameter 
        パラメーター:
        name - 初期化パラメーターの名前を指定する String 
        戻り値:
        初期化パラメーターの値を含む String をストリング化する
      • getInitParameterNames

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

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

        次で指定:
        インターフェース ServletConfiggetInitParameterNames 
        戻り値:
        サーブレットの初期化パラメーターの名前を含む String オブジェクトの列挙
      • getServletContext

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

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

        次で指定:
        インターフェース ServletConfiggetServletContext 
        戻り値:
        ServletContext init メソッドによってこのサーブレットに渡された ServletContext オブジェクト
        関連事項:
        ServletContext
      • getServletInfo

        public StringSE getServletInfo()
        作成者、バージョン、著作権など、サーブレットに関する情報を返します。デフォルトでは、このメソッドは空の文字列を返します。このメソッドをオーバーライドして、意味のある値を返すようにします。Servlet.getServletInfo() を参照してください。
        次で指定:
        インターフェース ServletgetServletInfo 
        戻り値:
        このサーブレットに関する文字列情報。デフォルトでは空の文字列
      • init

        public void init​(ServletConfig config)
                  throws ServletException
        サーブレットがサービスに配置されていることをサーブレットに示すために、サーブレットコンテナーによって呼び出されます。Servlet.init(jakarta.servlet.ServletConfig) を参照してください。

        この実装は、後で使用するためにサーブレットコンテナーから受け取った ServletConfig オブジェクトを格納します。この形式のメソッドをオーバーライドするときは、super.init(config) を呼び出します。

        次で指定:
        インターフェース Servletinit 
        パラメーター:
        config - このサーブレットの構成情報を含む ServletConfig オブジェクト
        例外:
        ServletException - サーブレットの通常の操作を中断する例外が発生した場合
        関連事項:
        UnavailableException
      • init

        public void init()
                  throws ServletException
        super.init(config) を呼び出す必要がないようにオーバーライドできる便利なメソッド。

        init(ServletConfig) をオーバーライドする代わりに、このメソッドをオーバーライドするだけで、GenericServlet.init(ServletConfig config) によって呼び出されます。ServletConfig オブジェクトは、getServletConfig() を介して引き続き取得できます。

        例外:
        ServletException - サーブレットの通常の操作を中断する例外が発生した場合
      • log

        public void log​(StringSE msg)
        サーブレットの名前を前に付けて、指定されたメッセージをサーブレットログファイルに書き込みます。ServletContext.log(String) を参照してください。
        パラメーター:
        msg - ログファイルに書き込まれるメッセージを指定する String 
      • log

        public void log​(StringSE message,
                        ThrowableSE t)
        特定の Throwable 例外の説明メッセージとスタックトレースをサーブレットログファイルに書き込み、サーブレット名を前に付けます。ServletContext.log(String, Throwable) を参照してください。
        パラメーター:
        message - エラーまたは例外を記述する String 
        t - java.lang.Throwable エラーまたは例外
      • service

        public abstract void service​(ServletRequest req,
                                     ServletResponse res)
                              throws ServletException,
                                     IOExceptionSE
        サーブレットがリクエストに応答できるようにするために、サーブレットコンテナーによって呼び出されます。Servlet.service(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse) を参照してください。

        このメソッドは抽象と宣言されているため、HttpServlet などのサブクラスでオーバーライドする必要があります。

        次で指定:
        インターフェース Servletservice 
        パラメーター:
        req - クライアントのリクエストを含む ServletRequest オブジェクト
        res - サーブレットのレスポンスを含む ServletResponse オブジェクト
        例外:
        ServletException - サーブレットの通常の動作を妨げる例外が発生した場合
        IOExceptionSE - 入力または出力の例外が発生した場合