6.4.1. リクエストボディ変換ハンドラ

本ハンドラでは、リクエストボディとレスポンスボディの変換処理を行う。

変換時に使用するフォーマットは、リクエストを処理するリソース(アクション)クラスのメソッドに設定された Consumes 及び Produces アノテーションで指定する。

本ハンドラでは、以下の処理を行う。

処理の流れは以下のとおり。

../../../../_images/flow15.png

6.4.1.2. モジュール一覧

<dependency>
  <groupId>com.nablarch.framework</groupId>
  <artifactId>nablarch-fw-jaxrs</artifactId>
</dependency>

6.4.1.3. 制約

本ハンドラは ルーティングアダプタ よりも後ろに設定すること
このハンドラは、リソース(アクション)クラスのメソッドに設定された、アノテーションの情報を元に リクエスト及びレスポンスの変換処理を行う。 このため、ディスパッチ先を特定する ルーティングアダプタ よりも後ろに設定する必要がある。

6.4.1.4. 変換処理を行うコンバータを設定する

このハンドラでは、 bodyConverters プロパティに設定された、 BodyConverter の実装クラスを使用してリクエスト及びレスポンスの変換処理を行う。 bodyConverters プロパティには、 プロジェクトで使用するMIMEに対応した、 BodyConverter を設定すること。

以下に例を示す。

<component class="nablarch.fw.jaxrs.BodyConvertHandler">
  <property name="bodyConverters">
    <list>
      <!-- application/xmlに対応したリクエスト・レスポンスのコンバータ -->
      <component class="nablarch.fw.jaxrs.JaxbBodyConverter" />
      <!-- application/x-www-form-urlencodedに対応したリクエスト・レスポンスのコンバータ -->
      <component class="nablarch.fw.jaxrs.FormUrlEncodedConverter" />
    </list>
  </property>
</component>

補足

bodyConverters プロパティに設定されたコンバータで、 変換出来ないMIMEが使用された場合、サポートしていないメディアタイプであることを示すステータスコード(415)を返却する。

6.4.1.5. リクエストボディをFormに変換する

リクエストボディの変換処理で使用するフォーマットは、リクエストを処理するメソッドに設定された Consumes により決まる。 もし、 Consumes に設定されたMIMEと異なるMIMEがリクエストヘッダのContent-Typeに設定されていた場合は、 サポートしていないメディアタイプであることを示すステータスコード(415)を返却する。

リソース(アクション)のメソッドの実装例を以下に示す。

この例では、 MediaType.APPLICATION_JSON が示す application/json に対応した BodyConverter でリクエストボディが Person に変換される。

@Consumes(MediaType.APPLICATION_JSON)
@Valid
public HttpResponse saveJson(Person person) {
    UniversalDao.insert(person);
    return new HttpResponse();
}

6.4.1.6. リソース(アクション)の処理結果をレスポンスボディに変換する

レスポンスボディへの変換処理で使用するフォーマットは、リクエストを処理したメソッドに設定された Produces により決まる。

リソース(アクション)のメソッドの実装例を以下に示す。

この例では、 MediaType.APPLICATION_JSON が示す application/json に対応した BodyConverter でリクエストボディが Person に変換される。

GET
@Produces(MediaType.APPLICATION_JSON)
public List<Person> findJson() {
    return UniversalDao.findAll(Person.class);
}