6.4.3. JAX-RSレスポンスハンドラ¶
目次
本ハンドラでは、後続のハンドラ(リソース(アクション)クラスや リクエストボディ変換ハンドラ) から戻されたレスポンス情報を、クライアントに返却する。 後続のハンドラで例外及びエラーが送出された場合には、エラー及び例外に対応したレスポンス情報を構築しクライアントに返却する。
本ハンドラでは、以下の処理を行う。
- 例外及びエラー発生時のレスポンス情報の生成を行う。 詳細は、 例外及びエラーに応じたレスポンスの生成 を参照。
- 例外及びエラー発生時のログ出力を行う。 詳細は、 例外及びエラーに応じたログ出力 を参照
- クライアントへのレスポンスの返却を行う。
処理の流れは以下のとおり。
6.4.3.2. モジュール一覧¶
<dependency>
<groupId>com.nablarch.framework</groupId>
<artifactId>nablarch-fw-jaxrs</artifactId>
</dependency>
6.4.3.3. 制約¶
なし。
6.4.3.4. 例外及びエラーに応じたレスポンスの生成¶
例外及びエラーに応じたレスポンス情報の生成は、 errorResponseBuilder プロパティに設定された ErrorResponseBuilder により行われる。 ただし、発生した例外クラスが HttpErrorResponse の場合は、 HttpErrorResponse#getResponse() から戻される HttpResponse がクライアントに戻される。
設定を省略した場合は、デフォルト実装の ErrorResponseBuilder が使用される。 デフォルト実装では、プロジェクト要件を満たせない場合は、デフォルト実装クラスを継承して対応すること。
以下に設定例を示す。
<component class="nablarch.fw.jaxrs.JaxRsResponseHandler">
<property name="errorResponseBuilder">
<component class="sample.SampleErrorResponseBuilder" />
</property>
</component>
6.4.3.5. 例外及びエラーに応じたログ出力¶
例外及びエラーに応じたログ出力は errorLogWriter プロパティに設定された JaxRsErrorLogWriter により行われる。
設定を省略した場合は、デフォルト実装の JaxRsErrorLogWriter が使用される。 デフォルト実装では、プロジェクト要件を満たせない場合は、デフォルト実装クラスを継承して対応すること。
以下に設定例を示す。
<component class="nablarch.fw.jaxrs.JaxRsResponseHandler">
<property name="errorLogWriter">
<component class="sample.SampleJaxRsErrorLogWriter" />
</property>
</component>
6.4.3.6. 拡張例¶
6.4.3.6.1. エラー時のレスポンスにメッセージを設定する¶
バリデーションエラー発生時など、エラーレスポンスのボディにエラーメッセージを設定して返却したい場合がある。 このような場合は、 ErrorResponseBuilder の継承クラスを作成して対応する。
以下に、JSON形式のエラーメッセージをレスポンスに設定する場合の実装例を示す。
public class SampleErrorResponseBuilder extends ErrorResponseBuilder {
private final ObjectMapper objectMapper = new ObjectMapper();
@Override
public HttpResponse build(final HttpRequest request,
final ExecutionContext context, final Throwable throwable) {
if (throwable instanceof ApplicationException) {
return createResponseBody((ApplicationException) throwable);
} else {
return super.build(request, context, throwable);
}
}
private HttpResponse createResponseBody(final ApplicationException ae) {
final HttpResponse response = new HttpResponse(400);
response.setContentType(MediaType.APPLICATION_JSON);
// エラーメッセージの生成処理は省略
try {
response.write(objectMapper.writeValueAsString(errorMessages));
} catch (JsonProcessingException ignored) {
return new HttpResponse(500);
}
return response;
}
}
6.4.3.6.2. 特定のエラーの場合に個別に定義したエラーレスポンスを返却する¶
本ハンドラの後続の処理で発生したエラーに対し、 個別にステータスコードやボディを定義したエラーレスポンスを返却したい場合がある。
その場合は ErrorResponseBuilder の継承クラスを作成し、 送出された例外に応じたレスポンスの生成処理を個別に実装する。
実装例を以下に示す。
public class SampleErrorResponseBuilder extends ErrorResponseBuilder {
@Override
public HttpResponse build(final HttpRequest request,
final ExecutionContext context, final Throwable throwable) {
if (throwable instanceof NoDataException) {
return new HttpResponse(404);
} else {
return super.build(request, context, throwable);
}
}
}