HttpErrorResponse (NablarchApi)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - nablarch.fw.web.HttpErrorResponse

```
@Published
public class HttpErrorResponse
extends java.lang.RuntimeException
```
エラーレスポンスを行う際に送出する例外。
エラー時遷移先画面のパス・ステータスコードなど、HttpResponseと同等の情報を指定することができる。リクエストプロセッサがこのクラスを捕捉した場合、保持しているHttpResponseオブジェクトの内容にしたがってレスポンス処理が行われる。注意: 透過的トランザクションハンドラ:nablarch.common.handler.TransactionManagementHandlerを適用している場合、ユーザエラーをHttpResponseオブジェクトで返却してしまうとロールバックされない。 HttpErrorResponseを送出することで、ユーザエラーを返しつつ、トランザクションをロールバックすることが可能となる。

Author:

Iwauo Tajima

See Also:

HttpResponse, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`HttpErrorResponse()` デフォルトコンストラクタ。
`HttpErrorResponse(HttpResponse response)` 指定された`HttpResponse`を持つ`HttpErrorResponse`を生成する。
`HttpErrorResponse(HttpResponse response, java.lang.Throwable e)` 指定された`HttpResponse`と例外を持つ`HttpErrorResponse`を生成する。
`HttpErrorResponse(int statusCode)` 指定されたステータスコードでエラーレスポンスを返す例外を生成する。
`HttpErrorResponse(int statusCode, java.lang.String contentPath)` 指定されたステータスコード・コンテンツパスでエラーレスポンスを返す例外を生成する。
`HttpErrorResponse(int statusCode, java.lang.String contentPath, java.lang.Throwable e)` 指定されたステータスコード・コンテンツパスでエラーレスポンスを返す例外を生成する。
`HttpErrorResponse(int statusCode, java.lang.Throwable e)` 指定されたステータスコードでエラーレスポンスを返す例外を生成する。
`HttpErrorResponse(java.lang.String contentPath)` コンテンツのパスを指定するコンストラクタ。
`HttpErrorResponse(java.lang.String contentPath, java.lang.Throwable e)` コンテンツのパスと元例外を指定するコンストラクタ。
`HttpErrorResponse(java.lang.Throwable e)` 元例外を指定するコンストラクタ。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpResponse`	`getResponse()` レスポンス情報を取得する。
`HttpErrorResponse`	`setResponse(HttpResponse response)` レスポンス情報を設定する。

- Constructor Detail
  - HttpErrorResponse
```
public HttpErrorResponse()
```
    デフォルトコンストラクタ。
```
 ステータスコードは400(Bad Request)を使用する。
 このコンストラクタの処理は、以下のコードと同等である。
     new HttpErrorResponse(400);
 
```
  - HttpErrorResponse
```
public HttpErrorResponse(java.lang.Throwable e)
```
    元例外を指定するコンストラクタ。
```
 ステータスコードは400(Bad Request)を使用する。
 このコンストラクタの処理は、以下のコードと同等である。
     new HttpErrorResponse(400, e);
 
```
    Parameters:
    
    e - Throwable
  - HttpErrorResponse
```
public HttpErrorResponse(java.lang.String contentPath)
```
    コンテンツのパスを指定するコンストラクタ。
```
 ステータスコードは400(Bad Request)を使用する。
 このコンストラクタの処理は、以下のコードと同等である。
     new HttpErrorResponse(400, "/error.jsp");
 
```
    Parameters:
    
    contentPath - レスポンスボディに出力するコンテンツのパス
  - HttpErrorResponse
```
public HttpErrorResponse(java.lang.String contentPath,
                         java.lang.Throwable e)
```
    コンテンツのパスと元例外を指定するコンストラクタ。
```
 ステータスコードは400(Bad Request)を使用する。
 このコンストラクタの処理は、以下のコードと同等である。
     new HttpErrorResponse(400, "/error.jsp", e);
 
```
    Parameters:
    
    contentPath - レスポンスボディに出力するコンテンツのパス
    
    e - Throwable
  - HttpErrorResponse
```
public HttpErrorResponse(int statusCode)
```
    指定されたステータスコードでエラーレスポンスを返す例外を生成する。
    
    Parameters:
    
    statusCode - ステータスコード
  - HttpErrorResponse
```
public HttpErrorResponse(int statusCode,
                         java.lang.Throwable e)
```
    指定されたステータスコードでエラーレスポンスを返す例外を生成する。
    
    Parameters:
    
    statusCode - ステータスコード
    
    e - 元例外
  - HttpErrorResponse
```
public HttpErrorResponse(int statusCode,
                         java.lang.String contentPath)
```
    指定されたステータスコード・コンテンツパスでエラーレスポンスを返す例外を生成する。
    
    Parameters:
    
    statusCode - ステータスコード
    
    contentPath - レスポンスボディに出力するコンテンツのパス
  - HttpErrorResponse
```
public HttpErrorResponse(int statusCode,
                         java.lang.String contentPath,
                         java.lang.Throwable e)
```
    指定されたステータスコード・コンテンツパスでエラーレスポンスを返す例外を生成する。
    
    Parameters:
    
    statusCode - ステータスコード
    
    contentPath - レスポンスボディに出力するコンテンツのパス
    
    e - 元例外
  - HttpErrorResponse
```
public HttpErrorResponse(HttpResponse response)
```
    指定されたHttpResponseを持つHttpErrorResponseを生成する。
    
    Parameters:
    
    response - HttpResponse
  - HttpErrorResponse
```
public HttpErrorResponse(HttpResponse response,
                         java.lang.Throwable e)
```
    指定されたHttpResponseと例外を持つHttpErrorResponseを生成する。
    
    Parameters:
    
    response - HttpResponse
    
    e - 元例外
- Method Detail
  - getResponse
```
public HttpResponse getResponse()
```
    レスポンス情報を取得する。
    
    Returns:
    
    レスポンス情報。
  - setResponse
```
public HttpErrorResponse setResponse(HttpResponse response)
```
    レスポンス情報を設定する。
    
    Parameters:
    
    response - レスポンス情報
    
    Returns:
    
    このオブジェクト自身

Class HttpErrorResponse

Constructor Summary

Method Summary

Constructor Detail

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

HttpErrorResponse

Method Detail

getResponse

setResponse