JAX-RS Web サービスの作成

始める前に

Web サービスをデプロイするには、 Java™ 5.0 以降の JVM サポートが導入されているサーバーを 定義して始動しておく必要があります。以下のようなサーバーが含まれます。
  • WebSphere® Application Server v7.0 または v8.0 で、Feature Pack for Web 2.0 AND MOBILE および WebSphere Application Server 開発用ツールのインストールを選択する。
デフォルトでは、WebSphere Application Server のインストール時にサーバーが作成されます。このサーバーは「サーバー」ビューで確認できます。

WebSphere Application Server 以外のサーバーへの デプロイを選択する場合は IBM® JAX-RS ライブラリーを使用することはできず、 「プロジェクト・ファセット」>「JAX-RS」設定ページから、独自の JAX-RS ライブラリーを インストールして構成する必要があります。

WebSphere Application Server での JAX-RS Web サービスの使用について詳しくは、WebSphere Application Server のインフォメーション・センターを参照してください。

JAX-RS 対応の Web プロジェクトの作成

このタスクについて

JAX-RS Web サービスは、JAX-RS ファセットに対応したプロジェクトに置かれている必要があります。

手順

  1. Java EE パースペクティブで、エンタープライズ・アプリケーション・プロジェクトを右クリックし、「新規」 > 「Web プロジェクト」を選択し、「Web プロジェクト」ウィザードを開きます。
  2. 「名前」フィールドに、新しい Web プロジェクトの名前を入力します。
  3. 「プロジェクト・テンプレート」セクションで、使用する Web テンプレートのタイプを選択します。 「シンプル」を選択して、シンプル Web プロジェクトを作成します。
  4. 「プログラミング・モデル」セクションで、使用するプログラミング・モデルを選択します。 「Java EE プログラミング・モデル」を選択します。 「次へ」をクリックして、新規 Web プロジェクトを構成します。
  5. 「デプロイメント」ページの選択可能構成オプションのリストから「デプロイメント」をクリックして、「デプロイメント構成」ページを開きます。
    • 「ターゲット・ランタイム」を変更するには、ドロップダウン・ボックスから別のランタイムを選択します。「フィーチャーの変更」をクリックして、「プロジェクト・ファセット」ウィンドウを開きます。 「プロジェクト・ファセット」ページで「JAX-RS (REST Web サービス)」を選択し、「OK」をクリックします。
    • 「WebSphere バインディングおよび拡張機能のサポートの追加」をクリックするか、またはこのフィールドをクリアします。
    • 「Web モジュールのバージョン」フィールドで、使用する Web モジュール・バージョンを選択します。
    • EAR メンバーシップを追加する場合、「EAR メンバーシップ」フィールドで「EAR にプロジェクトを追加」をクリックします。Web プロジェクトを EAR ファイルに追加しない場合はこのフィールドをクリアします。
    • 「EAR プロジェクト名」フィールドに既存の EAR ファイルの名前が表示されます。 「参照」をクリックして、別の EAR ファイルを選択することができます。
    注: 新規 Web プロジェクトのプログラミング・モデルとして「クライアント・サイドのみ」を選択した場合、 デプロイメント・オプションは選択不可になります。
  6. 選択可能構成オプションのリストから、「REST Services」をクリックします。
    1. 「JAX-RS 実装ライブラリー」フィールドで、ご使用のサーバー・バージョンに対応するライブラリーを選択します。例えば、「IBM WebSphere Application Server v8.0 JAX-RS ライブラリー」または「IBM WebSphere Application Server v8.5 JAX-RS ライブラリー」です。
      ライブラリーについてさらに学習したい方に: インストールした各 WebSphere テスト環境の JAX-RS ライブラリーは、このドロップダウン・ボックスにリストされます。WebSphere ライブラリー以外を使用したい場合、「ユーザー・ライブラリー」の設定ページを使用してインポートできます。「ユーザー・ライブラリー」を選択すると、「ユーザー・ライブラリー」設定ページを起動してライブラリーを追加できます。プロジェクトが作成されたら、 プロジェクトを右クリックして、「設定」 > 「プロジェクト・ファセット」 > 「JAX-RS」を選択することでライブラリーを変更できます。また、ウィザードがライブラリーを構成しないように選択することもできます。 その場合は、手動でクラスパスを構成する必要があります。
    2. v8 より前の WebSphere Application Server のバージョンを使用している場合は、「このアプリケーションにライブラリーを組み込む」 をチェックして「共有ライブラリー」として組み込むように選択します。これにより、JAX-RS JAR がクラスパスに追加され、 拡張 EAR に共有ライブラリー・エントリーが追加されます。
    3. web.xml を使用してセキュリティー制約および他の動作を構成する必要があるため、デフォルトで「デプロイメント記述子の更新」が選択されます。 デプロイメント記述子を生成しないことをウィザード内で既に選択した場合でも、 web.xml が生成され、JAX-RS サーブレット情報で更新されます。 このオプションは、選択されている Web モジュール・ファセットが v3.0 以降である時だけ使用可能です。
    4. デプロイメント記述子の更新を選択した場合、 サーブレット名とサーブレット・クラス名の変更、および URL マッピング・パターンの 変更を行うことができます。
  7. 「ターゲット・ランタイム」を変更するには、ドロップダウン・ボックスから別のランタイムを選択します。「フィーチャーの変更」をクリックして、「プロジェクト・ファセット」ウィンドウを開きます。
    • 「ビルド・パス上のソース・フォルダー」フィールドでデフォルトの src ディレクトリーを受け入れるか、「フォルダーの追加」「編集...」または「削除」をクリックして、ソース・ファイルのフォルダーを指定します。
    • 「デフォルト出力フォルダー:」フィールドで出力ファイルのフォルダーを指定するか、デフォルト値 (WebContent¥WEB-INF¥classes) を受け入れます。
  8. 選択可能構成オプションのリストから、「Web モジュール」をクリックします。「Web モジュール構成」ページで、以下のようにします。
    • 「コンテキスト・ルート」フィールドに、Web プロジェクト・ルートの名前を入力するか、デフォルト (Web プロジェクトの名前) を受け入れます。
    • 「コンテキスト・ディレクトリー」フィールドにコンテンツ・ディレクトリーの名前を入力するか、デフォルト (WebContent) を受け入れます。
    • デプロイメント記述子を作成する場合は、「web.xml デプロイメント記述子の生成」を選択します。 デプロイメント記述子を後で Web モジュールに追加することもできます。
  9. 「終了」をクリックします。

JAX-RS Web サービスの作成

手順

  1. Web プロジェクトで、パッケージを作成します (右クリックから「Java リソース」 > 「src」を選択し、「新規」 > 「パッケージ」を選択します)。Web サービスのクラスを パッケージにインポートします。
  2. WebContent/WEB-INF/web.xml を開きます。「設計」ビューで Servlet JAX-RS Servlet を選択し、名前および値フィールドが空白の状態で「追加」をクリックし、初期化パラメーターを JAX-RS サーブレットに追加します。web.xml を保存します。その際にエラーが表示される場合がありますが、無視してください。
  3. 「マーカー」ビューで、param-name に関する web.xml エラーを選択し、 右クリックして「クイック・フィックス」を選択します。アプリケーションをブラウズして、 選択します。
  4. JAX-RS プロジェクトが含まれる EAR をサーバーに追加し、 サーバーを始動します。

タスクの結果

すべての Web アプリケーションには、Web アプリケーションが 正常にデプロイするように、コンテキスト・ルートがなければなりません。各 Web モジュールの コンテキスト・ルートは、アプリケーション・アセンブリーまたはアプリケーション・デプロイメントの実行中に アプリケーション・デプロイメント記述子で定義されます。コンテキスト・ルートは、 WAR ファイルからの定義済みのサーブレット・マッピングと結合され、 ユーザーがサーブレットにアクセスする際に入力する完全な URL が作成されます。デプロイ済みの各 Web アプリケーションの コンテキスト・ルートは、サーバー上で固有でなければなりません。 コンテキスト・ルートは空にしておくこともできます。

例えば、 Web アプリケーションで sample/application/ というコンテキスト・ルートを使用する場合、この Web アプリケーションの要求 URL は http://<hostname>:<port>/sample/application/ で始まります。サーブレットの URL パターンは、Web アプリケーションの コンテキスト・ルートに追加されます。例えば、コンテキスト・ルートが sample/application/ でサーブレット URL マッピングが rest/api/* である場合、JAX-RS Web アプリケーションのベース URI は http://<hostname>:<port>/sample/application/rest/api となります。

JAX-RS プロジェクトの編集

JAX-RS Web サービスを作成した後、 プロジェクトを右クリックし、「プロパティー」 > 「プロジェクト・ファセット」 > 「JAX-RS」を選択することによって、これを編集することができます。このページから以下を変更できます。
  • ライブラリー・タイプ
  • JAX-RS サーブレット名
  • JAX-RS サーブレット・クラス名
  • URL マッピング・パターン
例えば、プロジェクトを他のサーバーにマイグレーションする場合、 ライブラリー・プロバイダーを新しいサーバーでサポートされるものに変更できます。
トピックのタイプを示すアイコン タスクのトピック
インフォメーション・センターのご利用条件 | フィードバック

タイム・スタンプ・アイコン 最終更新: May 29, 2014 10:20

ファイル名: tjaxrswebservcreate.html