HttpServlet (Java Servlet 4.0)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet

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

Serializable, Servlet, ServletConfig
```
public abstract class HttpServlet
extends GenericServlet
```
Webサイトに適したHTTPサーブレットを作成するためにサブクラスが作成される抽象クラスを提供します。 HttpServletのサブクラスはひとつ以上のメソッドをオーバーライドする必要があります。通常は以下のうちのどれかです。
- doGet、サーブレットがHTTP GETリクエストをサポートしている場合
- doPost、HTTP POSTリクエスト用
- doPut、HTTP PUTリクエスト用
- doDelete、HTTP DELETETリクエスト用
- init と destroy、サーブレットのライフサイクルで保持されているリソースの管理用
- getServletInfo、サーブレットが自身に関する情報を提供するために使用する
serviceメソッドをオーバーライドする理由はほとんどありません。 serviceメソッドは各HTTPのリクエストタイプの処理メソッド（上記のdoXXXメソッド）に標準HTTPリクエストをディスパッチして処理します。同様に、 doOptionsメソッドとdoTrace メソッドをオーバーライドする理由もほとんどありません。
サーブレットは通常、サーバー上でマルチスレッドで実行されるため、フィルタは同時に行われるリクエストを処理し、共有リソースへのアクセスを同期するよう注意しなければなりません。共有リソースにはインスタンス変数、クラス変数などのインメモリデータや、ファイル、データベース接続、ネットワーク接続などの外部オブジェクトが含まれます。 Javaプログラムで複数のスレッドを処理する方法の詳細は、Java Tutorial on Multithreaded Programmingを参照してください。
作成者:

Various

関連項目:

直列化された形式

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

コンストラクタ
コンストラクタと説明

HttpServlet()
このクラスはabstractクラスなので何もしません。

コンストラクタ
コンストラクタと説明
`HttpServlet()` このクラスはabstractクラスなので何もしません。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`doDelete(HttpServletRequest req, HttpServletResponse resp)` サーブレットがDELETEリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。
`protected void`	`doGet(HttpServletRequest req, HttpServletResponse resp)` サーブレットがGETリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。
`protected void`	`doHead(HttpServletRequest req, HttpServletResponse resp)` protectedな`service`メソッドからHTTP HEADリクエストを受け取り、リクエストを処理します。
`protected void`	`doOptions(HttpServletRequest req, HttpServletResponse resp)` サーブレットがOPTIONSリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。
`protected void`	`doPost(HttpServletRequest req, HttpServletResponse resp)` サーブレットがPOSTリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。
`protected void`	`doPut(HttpServletRequest req, HttpServletResponse resp)` サーブレットがPUTリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。
`protected void`	`doTrace(HttpServletRequest req, HttpServletResponse resp)` サーブレットがTRACEリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。
`protected long`	`getLastModified(HttpServletRequest req)` `HttpServletRequest`オブジェクトが最後に変更された時刻を1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数で返します。
`protected void`	`service(HttpServletRequest req, HttpServletResponse resp)` publicな`service`メソッドから標準のHTTPリクエストを受け取りこのクラスで定義されている`do`XXXメソッドにディスパッチします。
`void`	`service(ServletRequest req, ServletResponse res)` クライアントからのリクエストをprotectedな`service`メソッドにディスパッチします。

クラスから継承されたメソッド javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - HttpServlet
```
public HttpServlet()
```
    このクラスはabstractクラスなので何もしません。
    
    訳注：理由になってない・・・・・
- メソッドの詳細
  - doGet
```
protected void doGet(HttpServletRequest req,
                     HttpServletResponse resp)
              throws ServletException,
                     IOException
```
    サーブレットがGETリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。
    GETリクエストをサポートするためにこのメソッドをオーバーライドすると、HTTP HEADリクエストも自動的にサポートされます。 HEADリクエストはレスポンスとしてボディがないものが返されるリクエストヘッダフィールドのみのGETリクエストです。
    このメソッドをオーバーライドするときは、リクエストデータを読み込み、レスポンスヘッダーを書き、レスポンスのWriterまたはOutputStream オブジェクトを取得し、最後にレスポンスデータを書き込みます。コンテンツタイプとエンコーディングを含めることをお勧めします。 PrintWriterオブジェクトを使用してレスポンスを返す場合はPrintWriterオブジェクトにアクセスする前にコンテンツタイプを設定します。
    サーブレットコンテナはレスポンスをコミットする前にヘッダーを書き込まなければいけません。 HTTPではレスポンスボディの前にヘッダーを送信する必要があるからです。可能であれば(ServletResponse.setContentLength(int)メソッドを使用して)Content-Lengthヘッダーを設定し、サーブレットコンテナが永続的な接続を使用して応答をクライアントに返すようにし、パフォーマンスを向上させます。コンテンツの長さはレスポンス全体がレスポンスバッファ内に収まる場合には自動的に設定されます。
    HTTP 1.1チャンクエンコーディング(応答にTransfer-Encodingヘッダーがあることを意味します)を使用する場合は、 Content-Lengthヘッダーを設定しないでください。
    GETメソッドは安全である必要があります。つまりユーザーが責任を負うべき副作用はありません。たとえばほとんどの検索フォームは副作用がありません。クライアントのリクエストが格納されたデータを変更することを意図している場合、リクエストは他のHTTPメソッドを使用する必要があります。 GETメソッドは冪等である必要があります。つまり安全に繰り返すことができます。時にはメソッドを安全にすることも、メソッドを冪等にします。たとえば、検索を繰り返すことは安全かつ冪等ですが、オンラインで製品を購入したりデータを修正することは安全でもなく冪等でもありません。
    リクエストのフォーマットが正しくない場合、doGetはHTTP "Bad Request"メッセージを返します。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがGETリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - GETのためのリクエストが処理できなかった
    
    関連項目:
    
    ServletResponse.setContentType(java.lang.String)
  - getLastModified
```
protected long getLastModified(HttpServletRequest req)
```
    HttpServletRequestオブジェクトが最後に変更された時刻を1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数で返します。時刻が判らない場合、このメソッドは負の数を返します。(デフォルトです)
    HTTP GETリクエストをサポートし最後の変更時刻を迅速に判断できるサーブレットはこのメソッドをオーバーライドする必要があります。これによりブラウザやプロキシのキャッシュがより効果的に機能し、サーバーやネットワークリソースの負荷が軽減されます。
    訳注：HttpServletRequestオブジェクトでなく、リクエストに応じてこのサーブレットが示すリソースが最後に変更された時刻を返すのが正しい。
    
    パラメータ:
    
    req - サーブレットに送られた HttpServletRequest のオブジェクト
    
    戻り値:
    
    HttpServletRequestオブジェクトが最後に変更された時刻の1970 年 1 月 1 日 00:00:00 GMT からのミリ秒数のlong、不明な場合は-1
  - doHead
```
protected void doHead(HttpServletRequest req,
                      HttpServletResponse resp)
               throws ServletException,
                      IOException
```
    protectedなserviceメソッドからHTTP HEADリクエストを受け取り、リクエストを処理します。クライアントはContent-TypeやContent-Lengthなどのレスポンスのヘッダーに含まれる情報だけを参照したいときにHEADリクエストを送ります。 HTTP HEADメソッドはContent-Lengthヘッダを正確に設定するためにレスポンスの出力バイト数をカウントします。
    このメソッドをオーバーライドすると、レスポンスボディボディの計算を回避しレスポンスヘッダーを直接設定することでパフォーマンスを向上させることができます。書き込むdoHeadメソッドが安全かつ冪等である（つまり、一回のHTTP HEAD要求に対して複数回呼び出されないようにする）ことを確認してください。
    HTTP HEADリクエストのフォーマットが正しくない場合、doHeadはHTTP "Bad Request"メッセージを返します。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - I/Oエラーが発生した
    
    ServletException - HEADのためのリクエストが処理できなかった
  - doPost
```
protected void doPost(HttpServletRequest req,
                      HttpServletResponse resp)
               throws ServletException,
                      IOException
```
    サーブレットがPOSTリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。 HTTP POSTメソッドを使用するとクライアントウェブサーバーに無制限のデータを一度に送信できます。クレジットカード番号などの情報を送信するときにも便利です。
    このメソッドをオーバーライドするときは、リクエストデータを読み込み、レスポンスヘッダーを書き、レスポンスのWriterまたはOutputStream オブジェクトを取得し、最後にレスポンスデータを書き込みます。コンテンツタイプとエンコーディングを含めることをお勧めします。 PrintWriterオブジェクトを使用してレスポンスを返す場合はPrintWriterオブジェクトにアクセスする前にコンテンツタイプを設定します。
    サーブレットコンテナはレスポンスをコミットする前にヘッダーを書き込まなければいけません。 HTTPではレスポンスボディの前にヘッダーを送信する必要があるからです。可能であれば(ServletResponse.setContentLength(int)メソッドを使用して)Content-Lengthヘッダーを設定し、サーブレットコンテナが永続的な接続を使用して応答をクライアントに返すようにし、パフォーマンスを向上させます。コンテンツの長さはレスポンス全体がレスポンスバッファ内に収まる場合には自動的に設定されます。
    HTTP 1.1のチャンクエンコーディング（レスポンスにTransfer-Encodingヘッダーがあることを意味します）を使用する場合は Content-Lengthヘッダーを設定しないでください。
    このメソッドは安全でも冪等でもある必要はありません。 POSTによって行われる操作にはユーザーが責任を負う可能性のある副作用があります。例えば、保存されたデータの更新や、オンラインでの商品の購入などです。
    HTTP POSTリクエストのフォーマットが正しくない場合、doPostはHTTP "Bad Request"メッセージを返します。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - POSTのためのリクエストが処理できなかった
    
    関連項目:
    
    ServletOutputStream, ServletResponse.setContentType(java.lang.String)
  - doPut
```
protected void doPut(HttpServletRequest req,
                     HttpServletResponse resp)
              throws ServletException,
                     IOException
```
    サーブレットがPUTリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。 PUT操作ではクライアントはFTPでファイルを送信する場合と同様にサーバーにファイルを置くことができます。
    このメソッドをオーバーライドするときは、リクエストで送信されたコンテンツヘッダー(Content-Length、Content-Type、Content-Transfer-Encoding、 Content-Encoding、Content-Base、Content-Language、Content-Location、 Content-MD5、Content-Rangeが含まれる)を完全にそのままにしてください。メソッドがコンテンツヘッダーを処理できない場合はエラーメッセージ(HTTP 501 - Not Implemented) を発行しリクエストを破棄する必要があります。 HTTP 1.1のより詳細な情報については、RFC 2616を参照してください。 .
    このメソッドは安全でも冪等でもある必要はありません。 doPutによって行われる操作にはユーザーが責任を負う可能性のある副作用があります。このメソッドを使用する場合は、影響を受けるURLのコピーをテンポラリ領域に保存すると便利です。
    HTTP PUTリクエストのフォーマットが正しくない場合、doPutはHTTP "Bad Request"メッセージを返します。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがPUTリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - PUTのためのリクエストが処理できなかった
  - doDelete
```
protected void doDelete(HttpServletRequest req,
                        HttpServletResponse resp)
                 throws ServletException,
                        IOException
```
    サーブレットがDELETEリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。 DELETEの操作ではクライアントはサーバーからドキュメントもしくはウェブページを削除できます。
    このメソッドは安全でも冪等でもある必要はありません。 DELETEによって要求された操作にはユーザーが責任を負う可能性のある副作用があります。このメソッドを使用する場合は、影響を受けるURLのコピーをテンポラリ領域に保存すると便利です。
    HTTP DELETEリクエストのフォーマットが正しくない場合、doDeleteはHTTP "Bad Request"メッセージを返します。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがDELETEリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - DELETEのためのリクエストが処理できなかった
  - doOptions
```
protected void doOptions(HttpServletRequest req,
                         HttpServletResponse resp)
                  throws ServletException,
                         IOException
```
    サーブレットがOPTIONSリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。 OPTIONS要求はサーバーがサポートするHTTPメソッドを測定し適切なヘッダーを返します。たとえば、サーブレットがdoGetメソッドをオーバーライドする場合、このメソッドは次のヘッダーを返します。
    Allow: GET, HEAD, TRACE, OPTIONS
    サーブレットがHTTP 1.1で実装されているものよりも新しく制定されたHTTPメソッドを実装していない限り、このメソッドをオーバーライドする必要はありません。
    訳注：HTTP/2でもHTTPのメソッドは増えていないのでこのドキュメントの内容は有効です。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがOPTIONSリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - OPTIONSのためのリクエストが処理できなかった
  - doTrace
```
protected void doTrace(HttpServletRequest req,
                       HttpServletResponse resp)
                throws ServletException,
                       IOException
```
    サーブレットがTRACEリクエストを処理できるようにするために(serviceメソッド経由で)サーバーによって呼び出されます。 TRACEは、TRACEリクエストとともに送信されたヘッダーをクライアントに戻しデバッグに使用できるようにします。このメソッドをオーバーライドする必要はありません。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがTRACEリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - TRACEのためのリクエストが処理できなかった
  - service
```
protected void service(HttpServletRequest req,
                       HttpServletResponse resp)
                throws ServletException,
                       IOException
```
    publicなserviceメソッドから標準のHTTPリクエストを受け取りこのクラスで定義されているdoXXXメソッドにディスパッチします。このメソッドはServlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)メソッドのHTTPに特化したバージョンです。このメソッドをオーバーライドする必要はありません。
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    resp - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがHTTPリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - HTTPリクエストが処理できなかった
    
    関連項目:
    
    Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
  - service
```
public void service(ServletRequest req,
                    ServletResponse res)
             throws ServletException,
                    IOException
```
    クライアントからのリクエストをprotectedなserviceメソッドにディスパッチします。このメソッドをオーバーライドする必要はありません。
    
    定義:
    
    service インタフェース内 Servlet
    
    定義:
    
    service クラス内 GenericServlet
    
    パラメータ:
    
    req - クライアントからのリクエストを含むHttpServletRequestオブジェクト
    
    res - クライアントに返すレスポンスを含むHttpServletResponseオブジェクト
    
    例外:
    
    IOException - サーブレットがHTTPリクエストを処理しているときにI/Oエラーが発生した
    
    ServletException - HTTPリクエストが処理できなかったか、受け取ったパラメーターがそれぞれHttpServletRequestかHttpServletResponseのインスタンスでなかった場合。
    
    関連項目:
    
    Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)

Copyright © 1999-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation. Portions Copyright © 2017- @megascus. Translated by @megascus.

クラス HttpServlet

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

メソッドのサマリー

クラスから継承されたメソッド javax.servlet.GenericServlet

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

コンストラクタの詳細

HttpServlet

メソッドの詳細

doGet

getLastModified

doHead

doPost

doPut

doDelete

doOptions

doTrace

service

service