JAX-RS 2.0 リソース用のサンプル・クライアント・コードの生成

REST プロジェクト・アドレスから Java™ API for RESTful Web Services (JAX-RS) リソース用のサンプル・クライアント・コードを生成できます。

始める前に

重要: Liberty に適用可能
WebSphere® Application Server Developer Tools for Eclipse の以下のセットアップを実行します。
  • Liberty ランタイムを設定に追加します。
  • 「サーバー」ビューで Liberty サーバーを作成します。
  • プロジェクトに定義されている 1 つ以上の REST サービスを指定して Web プロジェクトを作成します。そうではなく、サービスを定義しない場合は、REST ノードに子はありません。

手順

  1. 「your_REST_project」 > 「サービス」 > 「REST」を展開します。
  2. アドレスまたはいずれかの子を右クリックして、「生成」 > 「JAX-RS クライアント」を選択します。 「JAX-RS 2.0 クライアント」ダイアログが表示されます。
    1. 「ソース・フォルダー」フィールドで、デフォルトを受け入れるか、生成されるクライアントの宛先フォルダーを指定します。
    2. 「名前」フィールドで、デフォルトを受け入れるか、クライアントの Java クラス名を指定します。
    3. 「パッケージ」フィールドで、デフォルトを受け入れるか、クライアントの Java パッケージ名を指定します。
    4. クライアント・コードの生成に使用するリソースを選択します。
    5. 新規フィルター・クラスを生成します。
      1. 「JAX-RS クライアント・フィルターの生成 (Generate JAX-RS Client Filter)」を選択します。
      2. デフォルトを受け入れるか、フィルター・クラスの名前を指定します。

      このオプションにより、JAX-RS 2.0 javax.ws.rs.client パッケージから ClientRequestFilter インターフェースおよび ClientResponseFilter インターフェースを実装する最小限必要なクラスが作成されます。新規フィルター・クラスを生成した後に、インターフェース・メソッドの実装の詳細を指定できます。

  3. オプション: JAXB クラスおよびクライアントを同じプロジェクトに生成するには、「JAXB の生成に XML スキーマを使用 (Use XML Schema for JAXB Generation)」を選択します。

    JAX-RS サービスのリソース・メソッドには、メソッド引数または戻りの型として JAXB クラスが指定されている可能性があります。JAXB ソースがなく、XML スキーマがある場合は、クライアント・コードがアクセスできるように JAXB クラスを生成できます。

    1. 「次へ」をクリックします。

      「JAXB を使用する JAX-RS クライアント (JAX-RS Client with JAXB)」ダイアログが表示されます。

    2. オプション: 「JAXB のターゲット Java パッケージ (JAXB Target Java Package)」フィールドに、生成された JAXB クラスに使用する Java パッケージを指定します。

      この値は、バインディング・コンパイラーまたは Java Architecture for XML Binding Compiler (XJC) ツールに -p オプションを指定して渡されます。

    3. 「参照...」をクリックして、JAXB クラスの生成元の XSD ファイルを参照します。

      XSD ファイルを「XML スキーマ」に入力することもできます。この値は、バインディング・コンパイラーまたは XJC ツールに -b オプションを指定して渡されます。

    4. オプション: ユーザー定義の JAXB バインディング・ファイルを指定するには、「JAXB バインディング・ファイルの指定 (Specify JAXB binding files)」を選択します。

      このオプションを選択する場合、「追加」をクリックして、カスタム・バインディング宣言ファイルを追加することができます。ファイルを強調表示して「削除」を選択することで、ファイルを削除することもできます。

    5. オプション: ベンダー拡張機能を許可するには、「ベンダー拡張機能を許可」を選択します。

      この選択は、一部の XML スキーマ文書を処理するために必要になる場合があります。この値は、バインディング・コンパイラーまたは XJC ツールに -extension オプションを指定して渡されます。

  4. 「終了」をクリックします。

タスクの結果

これで、JAX-RS リソース用のサンプル・クライアント・コードが生成されました。

JAXB クラスを生成するオプションのステップを実行した場合は、JAX-RS クライアントと同じプロジェクト内に JAXB クラスも生成されています。

また、JAX-RS サービスへのアクセスに使用できる JAX-RS 2.0 クライアント API を使用して新規の Java クラス・ファイルも生成されました。JAX-RS サービスのすべての注釈付きメソッドには、JAX-RS サービス・メソッドの注釈から生成された、対応する JAX-RS クライアント・メソッドがあります。JAX-RS サービス・メソッドには、@PathParam、@QueryParam、@Consumes、@Produces、@Path、およびリソース・メソッド (@GET、@PUT、または @POST など) があります。

制約事項: JAX-RS クライアント生成アルゴリズムの影響を受けるすべてのクラスが以下の制約に従う必要があります。
  • これらのクラスは、ストリング、プリミティブ、JAX-RS API クラス、または Java Architecture for XML Binding (JAXB) によって注釈を付けられたユーザー・クラスでなければなりません。これらのクラスは、バイナリーであってはなりません。
  • アルゴリズムが検出できるように、すべてのクラスがソース・フォームになければなりません。クラスが JAX-RS サービスと同じプロジェクト内にない場合は、JAX-RS クライアントを生成できません。

次のタスク

クライアント・コードが機能して、JAX-RS 2.0 クライアント・コードのニーズに対応できるように、コードをサンプルに追加します。サンプルをテストするには、クライアント・コードを JSP またはサーブレットに追加します。スタンドアロンの Java アプリケーションはサポートされていないため、クライアント・コードはサーブレット・コンテナー内になければなりません。機能する JAX-RS 2.0 クライアント・コードを用意した後、クライアント・コードを使用して JAX-RS 2.0 サービスを開始します。
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_jaxrs_scc_jaxrs.html