Red Hat Summit12.4. Web サービスのモデリング
12.4.1. Web サービスの作成
リンクのコピーリンクがクリップボードにコピーされました!
このメソッドは、リレーショナルソースのクエリーを目的とする迅速で一貫した Web サービスのデプロイメントを行う経験者に奨励されるメソッドです。XML ビューからのすべての Web サービスインターフェース、演算、および必要なトランスフォーメーションを詳細に制御できます。
リレーショナルモデルまたはオブジェクトから Web サービスモデルを作成するには、以下を実行します。
- Mode Explorer のビューツリーでリレーショナルモデル、テーブル、プロシージャーの組み合わせを選択します。
注記
手順 3 で入出力スキーマおよび Web サービスモデルの自動命名が有効になるため、単一のソースモデルを選択することが推奨されます。 - 右クリックして Modeling > Create Web Service アクションを選択します。
図12.24 Web サービスの作成
- Create Web Service ダイアログで、生成された入力スキーマファイル、出力スキーマファイル、および Web サービスモデルのファイル名を指定します。必要な場合はオプションを変更します。 最後に Finish をクリックします。
図12.25 Create Web Service ダイアログ
- モデルの生成が終了したら、確認ダイアログが表示されます。OK をクリックします。
図12.26 Generation Completed ダイアログ
12.4.2. Web サービス war の生成
リンクのコピーリンクがクリップボードにコピーされました!
12.4.2.1. Web サービス war の生成
リンクのコピーリンクがクリップボードにコピーされました!
Teiid Designer では、SOAP または REST インターフェースより VDB を公開できます。 JBossWS-CXF または RESTEasy war は、VDB 内のモデルを基に生成できます。
12.4.2.2. JBossWS-CXF war の生成
リンクのコピーリンクがクリップボードにコピーされました!
Teiid Designer は、JBossWS-CXF war の形式で Web サービス生成機能を提供します。「新しい Web サービスビューモデル」での説明どおり Web サービスモデルを VDB に追加し、VDB を稼働中の JBoss Data Virtualization インスタンスにデプロイし、VDB のデータソースを作成したら、生成された war を使用して Web サービスを公開する準備が整います。
VDB を使用して新しい JBossWS-CXF war を生成するには、以下を行います。
- Web サービスモデルが含まれる VDB を右クリックし、 Modeling > Generate JBossWS-CXF War と選択します。
図12.27
- 以下のように、Web Service War Generation Wizard で不足しているプロパティーを入力します。
図12.28 Generate a JBossWS-CXF War Web Service ダイアログ
Expand 表12.7 フィールドの説明 フィールド名 説明 名前 生成された war ファイルの名前。 ホスト サーバーのホスト名 (または IP)。 ポート サーバーポート。 VDB JNDI Name デプロイされた Teiid ソース VDB への JNDI 接続名。 Security options- None - 生成された Web サービスを介した VDB への接続にユーザー名やパスワードは必要ありません。
- HTTP Basic - 指定されたセキュリティーレルムおよびロールが使用されます。デフォルトのレルム値は、設定変更のない JBoss Data Virtualization (teiid-security) のレルムです。ロールは適切なセキュリティーメカニズムで定義する必要があります。Teiid の場合、
teiid-security-roles.propertiesファイルを使用します。HTTPBasic を使用する場合、PassthroughAuthentication プロパティーを使用するローカルの Teiid 接続が必要になります。 - WS-Security - war generator ダイアログに指定したユーザー名とパスワードの値が渡されるか検証するパスワードコールバッククラスが生成されます。これは、WS-Seurity が有効になっている Web サービスのテストメカニズムと独自のセキュリティーメカニズムがこのクラスに実装される必要があることを意味します。すべてのソースコードがコンパイルされたクラスファイルとともに生成された war に含まれます。
Target namespace 生成された WSDL および後続の生成された Web サービスクラスで使用される目的の名前空間。 MTOM (Message Transmission Optimization Mechanism) 生成されると、MTOM は Web サービスエンドポイントに対して有効になります。また、xmlns:xmime="http://www.w3.org/2005/05/xmlmim" スキーマと type="xs:base64Binary"xmime:expectedContentTypes="application/octet-stream" を最適化する出力要素に追加し、出力スキーマを更新する必要があります。 War File Save Location 生成された WAR ファイルが保存されるフォルダー。 - OK をクリックし、Web サービス war を生成します。war の生成が完了したら、確認ダイアログが表示されます。OK をクリックします。
図12.29 Generation Completed ダイアログ
- OK をクリックします。
12.4.2.3. RESTEasy war の生成
リンクのコピーリンクがクリップボードにコピーされました!
Teiid Designer では、生成された RESTEasy war を使用して REST 上で VDB を公開することも可能です。目的の仮想モデルに SQL の更新、挿入、および削除が定義されている場合、REST より簡単に CRUD 機能を提供できます。生成された REST 演算へ許可される入力は、URI パスパラメーター、クエリーパラメーター、XML/JSON です。JSON は、「json」が含まれる URI 上で公開されます。たとえば、
http://{host}:{port}/{war_context}/{model_name}/resource は URI パスパラメーターや XML を許可し、http://{host}:{port}/{war_context}/{model_name}/json/resource は URI パスパラメーターや JSON を許可します。また、REST:URI = authors&parm1&parm2 のように & を区切り文字として使用して目的の REST プロシージャーの URI プロパティーにあるクエリーパラメーターを指定できます。
- 仮想モデルで、XMLLiteral オブジェクトを返すプロシージャーを追加します。VDB のすべてのモデルをプロシージャーのターゲットとすることができます。仮想テーブル (VirtualBooks) から選択し、結果を XMLLiteral として返すプロシージャーの例を以下に示します。
図12.30
選択のリレーショナルテーブルの結果を VirtualBooks から XMLLiteral に変換する構文に注目してください。行を追加し、XMLLiteral オブジェクトを返す更新プロシージャーの例は次のとおりです。図12.31
REST プロシージャーの入力形式は、URI パラメーター、XML/JSON ドキュメント、または両方の組み合わせの一部になります。XML ドキュメントを使用する場合は、ルートノードが <input> である必要があり、XML ノードがプロシージャーの入力パラメーターの順番に対応する必要があります。たとえば、上記の挿入プロシージャーの入力は次のとおりです。図12.32 XML 入力の例
JSON ドキュメントを使用する場合は、値がプロシージャー入力パラメーターの順番と一致するようにしてください。上記の挿入プロシージャーの入力は次のとおりです。図12.33 JSON 入力の例
- ここでプロシージャーを REST 対応であると特定する必要があります。これには、Modeling > Enable REST for Procedures とコンテキストメニューオプションを選択し、プロシージャーのプロパティーを追加します。
図12.34
これにより、モデルで定義されたすべてのプロシージャーに対し、プロパティータブで 2 つの新しいプロパティーが有効になります。必要な 2 つのプロパティーは次のとおりです。Expand 表12.8 RESTful プロシージャーの必要な拡張プロパティー プロパティー名 説明 REST メソッド このプロシージャーの REST マッピングを決定する HTTP メソッド。サポートされるメソッドは GET、PUT、POST、および DELETE です。 URI プロシージャーへのリソースパス。たとえば、books/{isbn} をプロシージャーの URI 値として使用する場合、このプロシージャーは http://{host}:{port}/{war_context}/{model_name}/books/123 によって実行され、123 がパラメーターとして渡されます。 上記の例は Property タブでは次のように表示されます。図12.35
生成された URI にはパスの一部としてモデル名が含まれるため、完全な URL は「http://{host}:{port}/{war_context}/{model_name}/books/123」のようになります。REST サービスがすべて本 (book) を返すようにするには、上記のとおりにプロシージャーを記述して入力パラメーターのみ削除します。URI プロパティーは「books」のみになり (または指定するもの)、URL は「http://{host}:{port}/{war_context}/{model_name}/books」になります。必要な拡張プロパティーとともにすべてのプロシージャーを追加したら、モデルを VDB に追加します。モデルがすでに VDB に含まれている場合は同期します。その後、VDB を再デプロイする必要があります。重要
開発中に VDB を再デプロイした場合、プールに対して陳腐化した接続が取得され、「Invalid Session Exception」(無効なセッション例外) が発生することがあります。これを修正するにはデータソースをフラッシュしますが、テストクエリーを VDB 接続の -ds.xml ファイルに追加して修正することもできます。これにより、VDB を再デプロイした後に確実に有効な接続を取得することができます。テストクエリーの構文は <check-valid-connection-sql>some arbitrary sql</check-valid-connection-sql> になります。 - VDB のデータソースを作成していない場合は作成する必要があります。これは、Teiid Designer の Server view で行うことができます。デプロイした VDB を右クリックし、Create Data Source を選択します。VDB に接続するため、Generate REST WAR ダイアログで作成したソースの JNDI 名が要求されます。
- REST 対応のプロシージャーを持つ仮想モデルが含まれる VDB を右クリックし、Modeling > Generate RESTEasy War と選択します。REST 対応のプロシージャーがない場合、「Generate RESTEasy War」オプションは有効になりません。
図12.36
- 以下のように REST War Generation Wizard で不足しているプロパティーを入力します。
図12.37 Generate a REST WAR War File ダイアログ
Expand 表12.9 フィールドの説明 フィールド名 説明 名前 生成された war ファイルの名前。 Connection JNDI Name デプロイされた Teiid ソース VDB への JNDI 接続名。 War File Save Location 生成された WAR ファイルが保存されるフォルダー。 Include RESTEasy Jars in lib Folder of WAR 選択すると、RESTEasy jar とそれらが依存する jar が生成された WAR の lib フォルダーに含まれるようになります。選択しないと、jar は含まれません。RESTEasy がサーバーインストールのクラスパスにインストールされている環境では、これを未選択にして競合を防ぐ必要があります。 - OK をクリックして REST war を生成します。war の生成が完了したら確認ダイアログが表示されます。OKをクリックします。
図12.38 Generation Completed ダイアログ
12.4.2.4. 生成された WAR ファイルのデプロイ
リンクのコピーリンクがクリップボードにコピーされました!
war ファイルを生成したら、JBoss AS インスタンスにデプロイする必要があります。デプロイを行う方法は複数あります。
JBDS または JBoss Tools から
- 目的の JBoss AS が設定され、実行されていることを確認します。
- Model Explorer ビューで WAR ファイルを選択します。その場所に war を生成しなかった場合は、コピーして貼り付けできます。
- WAR ファイルを右クリックし、Mark as Deployable 選択します。これにより、定義した JBoss AS インスタンスに WAR ファイルが自動的にデプロイされます。
図12.39
JBoss AS 管理コンソールを使用
- JBoss AS に同梱される管理コンソールを使用して、WAR ファイルをデプロイできます。管理コンソールは、http://{host:port}/admin-console にあります。ログインしたら、Web Application (WAR) リソースフォルダーの Add a New Resource ボタンを使用します。
JBoss AS への手動デプロイメント
- 手動でファイルを JBoss AS の deploy フォルダーにコピーして、生成された WAR をデプロイすることも可能です。サーバーが稼働中の場合は、ホットデプロイで WAR は自動的にデプロイされます。それ以外の場合は、サーバーが次回起動したときに WAR がデプロイされます。
12.4.2.5. 生成された WAR ファイルのテスト
リンクのコピーリンクがクリップボードにコピーされました!
war ファイルをデプロイしたら、テストすることができます。テストする方法は複数あります。
SOAP WAR テスト
- WSDL URL の判断
- http://{server:port}/jbossws/services で WSDL URL を確認できます。ここには、目的の JBoss AS サーバーのデプロイされた web サービスがすべてリストされます。サービスを見つけ、Endpoint Address リンクをクリックします。これにより、web サービスの WSDL が取得され、WSDL URL アドレスがブラウザーのアドレスバーに表示されます。
図12.40
WSDL URL を取得すると、JBDS や JBoss Tools に同梱される Web Service Tester や soapUI などの外部ツールを含むすべての SOAP テストツールを使用できます。 - JBoss AS 管理コンソールを使用
- JBoss AS に同梱される管理コンソールを使用して、WAR ファイルをデプロイできます。管理コンソールは、http://{host:port}/admin-console にあります。ログインしたら、Web Application (WAR) リソースフォルダーの Add a New Resource ボタンを使用します。
REST WAR テスト
- URI
- REST プロシージャーをモデル化したとき、対応する演算 (GET、PUT、POST、または DELETE) とともに定義された各 HTTP 演算に対して URI を割り当てました。各 URI のフルパスは、XML 入力/出力の場合は /{war_context}/{model_name}/{resource} として定義され、JSON 入力/出力の場合は /{war_context}/{model_name}/json/{resource} として定義されます。WSDL URL を使用すると、JBDS や JBoss Tools に同梱される Web Service Tester、および soapUI や cURL などの外部ツールなど、REST サポートが含まれるすべてのテストツールを使用できます。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}