RequestDispatcher (Java Servlet 4.0)

```
public interface RequestDispatcher
```
クライアントからリクエストを受け取り、サーバー上の任意のリソース(サーブレット、HTMLファイル、JSPファイルなど)を送信するオブジェクトを定義します。サーブレットコンテナは特定のパスまたは特定の名前で指定されたサーバーリソースのラッパーとして使用されるRequestDispatcherオブジェクトを作成します。
このインターフェースはサーブレットをラップするためのものですが、サーブレットコンテナは任意の種類のリソースをラップするためのRequestDispatcherオブジェクトを作成できます。

作成者:

Various

関連項目:

ServletContext.getRequestDispatcher(java.lang.String), ServletContext.getNamedDispatcher(java.lang.String), ServletRequest.getRequestDispatcher(java.lang.String)

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`ERROR_EXCEPTION` エラーディスパッチのときに伝播されるExceptionオブジェクトが保存されるリクエストの属性の名前
`static String`	`ERROR_EXCEPTION_TYPE` エラーディスパッチのときに伝播されるExceptionオブジェクトの型が保存されるリクエストの属性の名前
`static String`	`ERROR_MESSAGE` エラーディスパッチのときに伝播されるExceptionのメッセージが保存されるリクエストの属性の名前
`static String`	`ERROR_REQUEST_URI` エラーディスパッチのときに伝播されるエラーの原因となったリクエストURIが保存されるリクエストの属性の名前
`static String`	`ERROR_SERVLET_NAME` エラーディスパッチのときに伝播されるエラーの原因となったサーブレットの名前が保存されるリクエストの属性の名前
`static String`	`ERROR_STATUS_CODE` エラーディスパッチのときに伝播されるエラーの原因となったレスポンスのステータスコードが保存されるリクエストの属性の名前
`static String`	`FORWARD_CONTEXT_PATH` `forward`を使用したときにオリジナルのコンテキストパスが使用可能になるリクエストの属性の名前
`static String`	`FORWARD_MAPPING` `forward`を使用したときにオリジナルの`HttpServletMapping`が使用可能になるリクエストの属性の名前
`static String`	`FORWARD_PATH_INFO` `forward`を使用したときにオリジナルのパス情報が使用可能になるリクエストの属性の名前
`static String`	`FORWARD_QUERY_STRING` `forward`を使用したときにオリジナルのクエリー文字列が使用可能になるリクエストの属性の名前
`static String`	`FORWARD_REQUEST_URI` `forward`を使用したときにオリジナルのリクエストURIが使用可能になるリクエストの属性の名前
`static String`	`FORWARD_SERVLET_PATH` `forward`を使用したときにオリジナルのサーブレットパスが使用可能になるリクエストの属性の名前
`static String`	`INCLUDE_CONTEXT_PATH` `include`を使用したときにオリジナルのコンテキストパスが使用可能になるリクエストの属性の名前
`static String`	`INCLUDE_MAPPING` `include`を使用したときにオリジナルの`HttpServletMapping`が使用可能になるリクエストの属性の名前
`static String`	`INCLUDE_PATH_INFO` `include`を使用したときにオリジナルのパス情報が使用可能になるリクエストの属性の名前
`static String`	`INCLUDE_QUERY_STRING` `include`を使用したときにオリジナルのクエリー文字列が使用可能になるリクエストの属性の名前
`static String`	`INCLUDE_REQUEST_URI` `include`を使用したときにオリジナルのリクエストURIが使用可能になるリクエストの属性の名前
`static String`	`INCLUDE_SERVLET_PATH` `include`を使用したときにオリジナルのサーブレットパスが使用可能になるリクエストの属性の名前

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`void`	`forward(ServletRequest request, ServletResponse response)` サーブレットからのリクエストをサーバー上の別のリソース(サーブレット、JSPファイル、またはHTMLファイル)に転送します。
`void`	`include(ServletRequest request, ServletResponse response)` レスポンスにリソース(サーブレット、JSPページ、HTMLファイル)の内容を含めます。

- フィールドの詳細
  - FORWARD_REQUEST_URI
```
static final String FORWARD_REQUEST_URI
```
    forwardを使用したときにオリジナルのリクエストURIが使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - FORWARD_CONTEXT_PATH
```
static final String FORWARD_CONTEXT_PATH
```
    forwardを使用したときにオリジナルのコンテキストパスが使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - FORWARD_MAPPING
```
static final String FORWARD_MAPPING
```
    forwardを使用したときにオリジナルのHttpServletMappingが使用可能になるリクエストの属性の名前
    
    導入されたバージョン:
    
    4.0
    
    関連項目:
    
    定数フィールド値
  - FORWARD_PATH_INFO
```
static final String FORWARD_PATH_INFO
```
    forwardを使用したときにオリジナルのパス情報が使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - FORWARD_SERVLET_PATH
```
static final String FORWARD_SERVLET_PATH
```
    forwardを使用したときにオリジナルのサーブレットパスが使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - FORWARD_QUERY_STRING
```
static final String FORWARD_QUERY_STRING
```
    forwardを使用したときにオリジナルのクエリー文字列が使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - INCLUDE_REQUEST_URI
```
static final String INCLUDE_REQUEST_URI
```
    includeを使用したときにオリジナルのリクエストURIが使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - INCLUDE_CONTEXT_PATH
```
static final String INCLUDE_CONTEXT_PATH
```
    includeを使用したときにオリジナルのコンテキストパスが使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - INCLUDE_PATH_INFO
```
static final String INCLUDE_PATH_INFO
```
    includeを使用したときにオリジナルのパス情報が使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - INCLUDE_MAPPING
```
static final String INCLUDE_MAPPING
```
    includeを使用したときにオリジナルのHttpServletMappingが使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - INCLUDE_SERVLET_PATH
```
static final String INCLUDE_SERVLET_PATH
```
    includeを使用したときにオリジナルのサーブレットパスが使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - INCLUDE_QUERY_STRING
```
static final String INCLUDE_QUERY_STRING
```
    includeを使用したときにオリジナルのクエリー文字列が使用可能になるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - ERROR_EXCEPTION
```
static final String ERROR_EXCEPTION
```
    エラーディスパッチのときに伝播されるExceptionオブジェクトが保存されるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - ERROR_EXCEPTION_TYPE
```
static final String ERROR_EXCEPTION_TYPE
```
    エラーディスパッチのときに伝播されるExceptionオブジェクトの型が保存されるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - ERROR_MESSAGE
```
static final String ERROR_MESSAGE
```
    エラーディスパッチのときに伝播されるExceptionのメッセージが保存されるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - ERROR_REQUEST_URI
```
static final String ERROR_REQUEST_URI
```
    エラーディスパッチのときに伝播されるエラーの原因となったリクエストURIが保存されるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - ERROR_SERVLET_NAME
```
static final String ERROR_SERVLET_NAME
```
    エラーディスパッチのときに伝播されるエラーの原因となったサーブレットの名前が保存されるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
  - ERROR_STATUS_CODE
```
static final String ERROR_STATUS_CODE
```
    エラーディスパッチのときに伝播されるエラーの原因となったレスポンスのステータスコードが保存されるリクエストの属性の名前
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - forward
```
void forward(ServletRequest request,
             ServletResponse response)
      throws ServletException,
             IOException
```
    サーブレットからのリクエストをサーバー上の別のリソース(サーブレット、JSPファイル、またはHTMLファイル)に転送します。このメソッドはあるサーブレットがリクエストの事前処理を行い、別のリソースがレスポンスを生成することを可能にします。
    getRequestDispatcher()で取得したRequestDispatcherに対して、 ServletRequestオブジェクトはターゲットリソースのパスと一致するように調整されたパス要素とパラメーターを持ちます。
    forwardはレスポンスがクライアントにコミットされる前に(レスポンスボディの出力がフラッシュされる前に)呼び出される必要があります。レスポンスがすでにコミットされている場合、このメソッドはIllegalStateExceptionを投げます。レスポンスバッファ内のコミットされていない出力は、転送の前に自動的にクリアされます。
    リクエストとレスポンスのパラメーターは呼び出し側サーブレットのサービスメソッドに渡されたものと同じオブジェクトであるか、それらをラップするServletRequestWrapperクラスまたはServletResponseWrapperクラスのサブクラスでなければなりません。
    このメソッドは与えられたリクエストのdispatcher typeにDispatcherType.FORWARDを設定します。
    
    パラメータ:
    
    request - サーブレットのクライアントが作成したリクエストを表す ServletRequest オブジェクト
    
    response - サーブレットがクライアントへ返すレスポンスを表す ServletResponse オブジェクト
    
    例外:
    
    ServletException - ターゲットのリソースがこの例外を投げた
    
    IOException - ターゲットのリソースがこの例外を投げた
    
    IllegalStateException - レスポンスがすでにコミットされている場合
    
    関連項目:
    
    ServletRequest.getDispatcherType()
  - include
```
void include(ServletRequest request,
             ServletResponse response)
      throws ServletException,
             IOException
```
    レスポンスにリソース(サーブレット、JSPページ、HTMLファイル)の内容を含めます。本質的に、このメソッドはプログラムによるサーバーサイドインクルードを可能にします。
    ServletResponseオブジェクトには呼び出し元から変更されないままのパス要素やパラメーターを持ちます。インクルードするサーブレットはレスポンスのステータスコードを変更したり、ヘッダーを設定することはできません。変更しようとする試みはすべて無視されます。
    リクエストとレスポンスのパラメーターは呼び出し側サーブレットのサービスメソッドに渡されたものと同じオブジェクトであるか、それらをラップするServletRequestWrapperクラスまたはServletResponseWrapperクラスのサブクラスでなければなりません。
    このメソッドは与えられたリクエストのdispatcher typeにDispatcherType.INCLUDEを設定します。
    
    パラメータ:
    
    request - クライアントのリクエストを含む ServletRequest オブジェクト
    
    response - サーブレットのレスポンスを含む ServletResponse オブジェクト
    
    例外:
    
    ServletException - インクルードしたリソースがこの例外を投げた
    
    IOException - インクルードしたリソースがこの例外を投げた
    
    関連項目:
    
    ServletRequest.getDispatcherType()

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.

インタフェース RequestDispatcher

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

FORWARD_REQUEST_URI

FORWARD_CONTEXT_PATH

FORWARD_MAPPING

FORWARD_PATH_INFO

FORWARD_SERVLET_PATH

FORWARD_QUERY_STRING

INCLUDE_REQUEST_URI

INCLUDE_CONTEXT_PATH

INCLUDE_PATH_INFO

INCLUDE_MAPPING

INCLUDE_SERVLET_PATH

INCLUDE_QUERY_STRING

ERROR_EXCEPTION

ERROR_EXCEPTION_TYPE

ERROR_MESSAGE

ERROR_REQUEST_URI

ERROR_SERVLET_NAME

ERROR_STATUS_CODE

メソッドの詳細

forward

include