A ユーザー・メッセージング・サービス・サンプル・アプリケーションの使用

この付録では、Oracle User Messaging Service (UMS) Java APIを使用するクライアント・アプリケーションを作成する方法について説明します。

ノート:

Oracle User Messaging Serviceのコード・サンプルについてさらに学習したり、サンプルを自分で実行するには、次の場所にあるサンプルを参照してください。

http://www.oracle.com/technetwork/indexes/samplecode/sample-ums-1454424.html.

UMSクライアントAPIを使用したクライアント・アプリケーションの作成

この項では、usermessagingsampleというアプリケーションの作成方法について説明します。このアプリケーションは、アウトバウンド・メッセージングおよびメッセージ・ステータスの同期取得の両方に対してUMSクライアントAPIを使用するWebクライアント・アプリケーションです。usermessagingsampleはインバウンド・メッセージングもサポートしています。デプロイして構成したusermessagingsampleを使用すると、電子メール・クライアントにメッセージを送信できます。

このサンプルはWebアプリケーション・モジュール(WAR)に重点を置き、いくつかのHTMLフォームとサーブレットを定義します。Webアプリケーション・モジュールのコードと対応するXMLファイルは、提供されているusermessagingsample-src.zipソースから使用できます。サーブレットでは、UMSクライアントAPIを使用して、UMSクライアント・インスタンスを作成し(次に、アプリケーションの情報を登録します)、メッセージを送信します。

このアプリケーションはusermessagingsample.earというEnterprise Archive (EAR)ファイルとしてパッケージ化されており、その構造は次のとおりです。

  • usermessagingsample.ear

    • META-INF

      • application.xml -- すべてのアプリケーション・モジュール用のディスクリプタ・ファイル。

      • weblogic-application.xml -- oracle.sdp.messaging共有ライブラリのimportを含むディスクリプタ・ファイル。

    • usermessagingsample-web.ear -- Webベースのフロント・エンドおよびサーブレットが格納されます。

      • WEB-INF

      • web.xml

      • weblogic.xml

ビルトインのサンプル・アプリケーションおよびソース・コード(usermessagingsample-src.zip)は、OTNで入手できます。

開発の概要

次の各項では、usermessagingsample.earを例にして、アウトバウンド・メッセージング機能を持つアプリケーションの作成プロセスを説明します。

  1. 電子メール・ドライバの構成

  2. JDeveloper 14cを使用したアプリケーションの作成

  3. アプリケーションのデプロイ

  4. アプリケーションのテスト

電子メール・ドライバの構成

Oracle User Messaging Serviceの電子メール・ドライバを有効にしてアウトバウンド・メッセージングおよびステータスの取得を実行するには、電子メール・ドライバを構成する際、SMTPメール・サーバーの名前をOutgoingMailServerプロパティ値として入力します。

電子メール・ドライバの構成の詳細は、『Oracle User Messaging Serviceの管理』を参照してください。

ノート:

このサンプル・アプリケーションは汎用的であるため、適切なメッセージング・ドライバがデプロイされて構成されている場合は、他のチャネル経由のアウトバウンド・メッセージングもサポートできます。

JDeveloper 14cを使用したアプリケーションの作成

この項では、Windowsベース・ビルドのJDeveloperを使用して、usermessagingsampleを作成、コンパイルおよびデプロイするステップを説明します。

プロジェクトを開く
  1. Oracle JDeveloperで、usermessagingsample.jws (usermessagingsample-src.zipファイルに含まれています)を開きます。

    Oracle JDeveloperのメイン・ウィンドウにプロジェクトが表示されます。

  2. サンプル・アプリケーションを作成するには、WebモジュールにOracle UMSクライアント・ライブラリを含める必要があります。

    1. 「アプリケーション・ナビゲータ」で、Webモジュール「usermessagingsample-web」を右クリックし、「プロジェクト・プロパティ」を選択します。

    2. 左側のペインで、「ライブラリとクラスパス」を選択します。

    3. 「OK」をクリックします。

  3. usermessagingsample-webプロジェクトの下にあるJavaファイルを検索し、メッセージング・クライアントAPIを使用してメッセージの送信、ステータスの取得およびメッセージの同期受信を実行する方法を確認します。MessagingClientインスタンスは、プロジェクトのSampleUtils.javaに作成されます。

アプリケーションのデプロイ

アプリケーションをデプロイするステップは、次のとおりです。

  1. ナビゲーション・ペインでアプリケーションを右クリックし、「新規」を選択して、アプリケーション・サーバー接続を作成します。新規アプリケーション・サーバー接続の作成の説明に従います。

  2. アプリケーションをデプロイするには、「usermessagingsample application」「デプロイ」「usermessagingsample」「デプロイ先」「ums_server」の順に選択します。

  3. メッセージBuild Successfulがログに表示されていることを確認します。

  4. メッセージDeployment Finishedがデプロイメント・ログに表示されていることを確認します。

    アプリケーションが正常にデプロイされました。

    サンプルを実行するには、その前に、Oracle User Messaging Serviceの追加ドライバを構成し、必要に応じて、ユーザー通信プリファレンスでメッセージを受信するユーザー用のデフォルト・デバイスを構成する必要があります。

    ノート:

    詳細は、『Oracle User Messaging Serviceの管理』を参照してください。

アプリケーションのテスト

Oracle WebLogic Serverの実行中のインスタンスにusermessagingsampleをデプロイした後は、次の手順を実行します。

  1. Webブラウザを起動し、サンプル・アプリケーションのアドレスをhttp://host:http-port/usermessagingsample/と入力します。たとえば、ブラウザのナビゲーション・バーにhttp://localhost:7001/usermessagingsample/と入力します。

    プロンプトが表示された場合は、ログイン資格証明を入力します。たとえば、ユーザー名はweblogicと入力します。メッセージ・サンプルをテストするためのブラウザ・ページが表示されます。

  2. サンプル・メッセージの送信をクリックします。「メッセージの送信」ページが表示されます。

  3. (オプション)送信者アドレスを次の書式で入力します。

    Email:sender_address

    たとえば、Email:sender@example.comと入力します。

  4. 受信者アドレスを1つ以上入力します。たとえば、Email:recipient@example.comと入力します。複数のアドレスを入力する場合は、次のようにカンマ区切りリストで入力します。

    Email:recipient_address1, Email:recipient_address2

    ユーザー通信プリファレンスを構成している場合、メッセージのアドレスは単にUser:usernameと指定できます。たとえば、User:weblogicと入力します。

  5. (オプション)件名、つまり電子メールの内容を入力します。

  6. 「送信」をクリックします。トランザクションの進捗を示す「メッセージ・ステータス」ページが表示されます。「ステータス・コンテンツ」フィールドに「メッセージが処理のためにメッセージング・エンジンによって受信された」が表示されます。

  7. リフレッシュをクリックしてステータスを更新します。電子メール・メッセージが電子メール・サーバーに配信されると、「ステータスの内容」フィールドに「リモート・ゲートウェイへのアウトバウンド・メッセージの配信に成功しました。」と表示されます。

UMSクライアントAPIを使用したクライアント・エコー・アプリケーションの作成

この項では、usermessagingsample-echoというアプリケーションの作成方法について説明します。このアプリケーションは、UMSクライアントAPIを使用して、電子メール・アドレスからメッセージを非同期で受信し、リプライを送信者にエコーして戻すデモ・クライアント・アプリケーションです。

ノート:

Oracle User Messaging Serviceのコード・サンプルについてさらに学習したり、サンプルを自分で実行するには、http://www.oracle.com/technetwork/indexes/samplecode/sample-ums-1454424.htmlのOracle User Messaging Serviceサンプルを参照してください。

このアプリケーションはusermessagingsample-echo.earというEnterprise Archive (EAR)ファイルとしてパッケージ化されており、その構造は次のとおりです。

  • usermessagingsample-echo.ear

    • META-INF

      • application.xml -- すべてのアプリケーション・モジュール用のディスクリプタ・ファイル。

      • weblogic-application.xml -- oracle.sdp.messaging共有ライブラリのimportを含むディスクリプタ・ファイル。

    • usermessagingsample-echo-web.war -- Webベースのフロント・エンドおよびサーブレットが格納されます。受信したメッセージを処理してエコー・レスポンスを戻すリスナーも含まれています。

      • WEB-INF

      • web.xml

      • weblogic.xml

ビルトインのサンプル・アプリケーションおよびソース・コード(usermessagingsample-echo-src.zip)は、OTNで入手できます。

開発の概要

次の各項では、usermessagingsample-echo.earを例にして、非同期のインバウンドおよびアウトバウンド・メッセージング機能を持つアプリケーションの作成プロセスを説明します。

  1. 電子メール・ドライバの構成

  2. Oracle JDeveloper 14cを使用したアプリケーションの作成

  3. アプリケーションのデプロイ

  4. アプリケーションのテスト

電子メール・ドライバの構成

Oracle User Messaging Serviceの電子メール・ドライバを有効にしてインバウンドやアウトバウンド・メッセージングおよびステータスの取得を実行するには、電子メール・ドライバを次のように構成します。

  • OutgoingMailServerプロパティの値として、SMTPメール・サーバーの名前を入力します。

  • IncomingMailServerプロパティの値として、IMAP4/POP3メール・サーバーの名前を入力します。受信ユーザー名とパスワードも構成します。

電子メール・ドライバの構成の詳細は、『Oracle Fusion Middleware Oracle User Messaging Serviceの管理』の電子メール・ドライバの構成に関する項を参照してください。

ノート:

このサンプル・アプリケーションは汎用的であるため、適切なメッセージング・ドライバがデプロイされて構成されている場合は、他のチャネル経由のインバウンドおよびアウトバウンド・メッセージングもサポートできます。

Oracle JDeveloper 14cを使用したアプリケーションの作成

この項では、Windowsベース・ビルドのJDeveloperを使用して、usermessagingsample-echoを作成、コンパイルおよびデプロイするステップを説明します。

プロジェクトを開く
  1. usermessagingsample-echo-src.zipJDEV_HOME/communications/ samples/ディレクトリに解凍します。共有ライブラリ参照をプロジェクトで有効にするには、このディレクトリを使用する必要があります。

    ノート:

    別のディレクトリを使用する場合は、oracle.sdp.messagingライブラリ・ソース・パスをJDEV_HOME/ communications/modules/oracle.sdp.messaging_12.1.3/ sdpmessaging.jarに更新する必要があります。
  2. Oracle JDeveloperで、usermessagingsample-echo.jws(.zipファイルに含まれています)を開きます。

    Oracle JDeveloperのメイン・ウィンドウにプロジェクトが表示されます。

  3. 次のライブラリがusermessagingsample-echo-webモジュールに追加されていることを確認して、サンプル・アプリケーションのビルド依存性が満たされていることを確認します。

    • ライブラリ: oracle.sdp.messaging、クラスパス: JDEV_HOME/ communications/modules/oracle.sdp.messaging_12.1.3/ sdpmessaging.jar。これはJavaライブラリで、UMS、およびUMSを使用してメッセージを送受信するアプリケーションで使用されます。

    各モジュールに対して次のステップを実行します。

    1. 「アプリケーション・ナビゲータ」で、モジュールを右クリックし、「プロジェクト・プロパティ」を選択します。

    2. 左側のペインで、「ライブラリとクラスパス」を選択します。

    3. 「OK」をクリックします。

  4. usermessagingsample-echo-webプロジェクトの下にあるJavaファイルを検索し、メッセージング・クライアントAPIを使用してアクセスを登録および登録解除する方法、およびEchoListenerを使用してメッセージを非同期で受信する方法を確認します。

アプリケーションのデプロイ

アプリケーションをデプロイするステップは、次のとおりです。

  1. ナビゲーション・ペインでアプリケーションを右クリックし、「新規」を選択して、アプリケーション・サーバー接続を作成します。新規アプリケーション・サーバー接続の作成の説明に従います。

  2. アプリケーションをデプロイするには、「usermessagingsample-echo application」「デプロイ」「usermessagingsample-echo」「デプロイ先」「ums_server」の順に選択します。

  3. メッセージBuild Successfulがログに表示されていることを確認します。

  4. メッセージDeployment Finishedがデプロイメント・ログに表示されていることを確認します。

    アプリケーションが正常にデプロイされました。

    サンプルを実行するには、その前に、Oracle User Messaging Serviceの追加ドライバを構成し、必要に応じて、ユーザー通信プリファレンスでメッセージを受信するユーザー用のデフォルト・デバイスを構成する必要があります。

    ノート:

    詳細は、『Oracle User Messaging Serviceによるアプリケーションの開発』を参照してください。

アプリケーションのテスト

Oracle WebLogic Serverの実行中のインスタンスにusermessagingsample-echoをデプロイした後は、次の手順を実行します。

  1. Webブラウザを起動し、サンプル・アプリケーションのアドレスをhttp://host:http-port/usermessagingsample-echo/と入力します。たとえば、ブラウザのナビゲーション・バーにhttp://localhost:7001/usermessagingsample-echo/と入力します。

    プロンプトが表示された場合は、ログイン資格証明を入力します。たとえば、ユーザー名はweblogicと入力します。メッセージ・サンプルをテストするためのブラウザ・ページが表示されます。

  2. アクセス・ポイントの登録/登録解除をクリックします。「アクセス・ポイントの登録」ページが表示されます。

  3. アクセスのアドレスを次の書式で入力します。

    EMAIL:server_address

    たとえば、EMAIL:myserver@example.comと入力します。

  4. アクションとして登録を選択し、送信をクリックします。登録ステータス・ページが表示され、「登録済」と表示されます。

  5. メッセージ・クライアント(電子メールの場合は電子メール・クライアント)から、前のステップでアクセスとして登録したアドレスに、メッセージを送信します。

    該当するチャネル用のUMSメッセージング・ドライバが正しく構成されている場合は、usermessagingsample-echoアプリケーションから戻されるエコー・メッセージを受信できるはずです。

新規アプリケーション・サーバー接続の作成

Oracle JDeveloperでアプリケーション・サーバー接続を定義し、アプリケーションをデプロイおよび実行します。

次のステップを実行し、アプリケーション・サーバー接続を作成します。

  1. プロジェクトを右クリックし、「新規」を選択します。コンテキスト・メニューから「ギャラリから」を選択します。「新規ギャラリ」ウィンドウの左側のペインで「接続」に移動し、項目リストから「アプリケーション・サーバー接続」を選択します。

    「OK」をクリックします。

  2. 「接続名」フィールドで、サーバー接続名(SOA_serverなど)を入力し、「次へ」をクリックします。

  3. 「接続タイプ」ドロップダウン・リストから「WebLogic 12.x」を選択します。

  4. 「認証」画面で、アプリケーション・サーバーの管理者のユーザー名パスワードを入力します。「次」をクリックします。

  5. 「構成」画面で、WebLogic Serverのホスト名、ポート、SSLポートおよびドメイン名を入力します。「次」をクリックします。

  6. 「テスト」画面で、「接続のテスト」をクリックし、接続を検証します。テストが成功すると、確認メッセージが表示されます。「終了」をクリックします。

    アプリケーション・サーバー接続が作成されました。

WebサービスAPIを使用したサンプル・チャット・アプリケーション

この項では、OTNでOracle User Messaging Serviceが提供するWebサービスAPIを使用して、サンプル・チャット・アプリケーションを作成、デプロイおよび実行する方法を説明します。

ノート:

Oracle User Messaging Serviceのコード・サンプルについてさらに学習したり、サンプルを自分で実行するには、次の場所にあるサンプルを参照してください。

http://www.oracle.com/technetwork/indexes/samplecode/sample-ums-1454424.html.

概要

このサンプルは、電子メール、SMSまたはIMを通じてメッセージを送受信するWebベースのチャット・アプリケーションの作成方法を示します。このサンプルでは、サービスWebサービスAPIを使用してユーザー・メッセージング・サーバーと相互作用します。Oracle JDeveloperでアプリケーション・サーバー接続を定義し、アプリケーションをデプロイおよび実行します。

このアプリケーションは、単純なWebチャット・インタフェースが含まれる、事前作成されたOracle JDeveloperプロジェクトとして提供されます。

ノート:

このサンプルが動作するには、UMSサーバーが使用でき、必要なドライバにより適切に構成されている必要があります。

提供されるファイル

サンプル・アプリケーションには、次のファイルが含まれています。

  • usermessagingsample-ws-src.zip - ソース・コードおよびOracle JDeveloperプロジェクト・ファイルが格納されたアーカイブです。

  • usermessagingsample-ws.ear - コンテナにデプロイ可能な、事前作成されたサンプル・アプリケーションです。

事前作成されたサンプルの実行

次のステップを実行して、事前作成されたサンプル・アプリケーションを実行し、デプロイします。

  1. usermessagingsample-ws-src.zipを抽出し、usermessagingsample-ws.jwsをOracle JDeveloperで開きます。

    Oracle JDeveloperのメイン・ウィンドウにプロジェクトが表示されます。

    このアプリケーションには、1つのWebモジュールが含まれています。アプリケーションのソース・コードはすべて設定済です。

  2. WebモジュールでOracle UMS Clientライブラリが使用されていることを確認して、サンプル・アプリケーションのビルド依存性を満たします。

    1. 「アプリケーション・ナビゲータ」で、Webモジュール「usermessagingsample-ws-war」を右クリックし、「プロジェクト・プロパティ」を選択します。

    2. 左側のペインで、「ライブラリとクラスパス」を選択します。

    3. 「OK」をクリックします。

  3. ナビゲーション・ペインでプロジェクトを右クリックし、「新規」を選択して、アプリケーション・サーバー接続を作成します。新規アプリケーション・サーバー接続の作成の説明に従います。

  4. プロジェクトをデプロイするには、「usermessasgingsample-ws project」「デプロイ」「usermessasgingsample-ws」「デプロイ先」「ums_server」の順に選択します。

  5. メッセージBuild Successfulがログに表示されていることを確認します。

  6. メッセージDeployment Finishedがデプロイメント・ログに表示されていることを確認します。

    アプリケーションが正常にデプロイされました。

サンプルのテスト

次のステップを実行し、サンプルを実行およびテストします。

  1. Webブラウザを開きます。

  2. 次のようにアプリケーションのURLに移動し、ログインします。

    http://host:port/usermessagingsample-ws/

    メッセージングWebサービス・サンプルWebページが表示されます。このページには、ナビゲーション・タブ、およびアプリケーションの手順が表示されます。

  3. 「構成」をクリックし、次の値を入力します:

    • Webサービスのエンドポイントを指定します。たとえば、http://example.com:8001/ucs/messaging/webservice

    • ユーザー名とパスワードを指定します。

    • ポリシーを指定します(ユーザー・メッセージング・サービスのインスタンスでWS-Securityが有効になっている場合に必要)。

  4. 「保存」をクリックします。

  5. 「管理」をクリックします。

  6. メッセージを受信するアドレスおよびオプションのキーワードを入力します。

  7. 「開始」をクリックします。

    メッセージRegistration operation succeededが表示されていることを確認します。

  8. 「チャット」をクリックします。

  9. 「至」フィールドに受信者を入力します。

  10. メッセージを入力します。

  11. 「送信」をクリックします。

  12. メッセージが受信されていることを確認します。

新規アプリケーション・サーバー接続の作成

Oracle JDeveloperでアプリケーション・サーバー接続を定義し、アプリケーションをデプロイおよび実行します。新規アプリケーション・サーバー接続の作成のステップを実行し、アプリケーション・サーバー接続を作成します。