Oracle® Oracle WebLogic Serverプロキシ・プラグインを使用したOracle User Messaging Serviceによるアプリケーションの開発 12c (12.2.1.3.0) E90138-01 |
|
前 |
この付録では、Oracle User Messaging Service (UMS) Java APIを使用するクライアント・アプリケーションを作成する方法について説明します。
この付録の構成は、次のとおりです。
注意: Oracle User Messaging Serviceのコード・サンプルに関する詳細を参照したり、サンプルを自分で実行するには、次の場所にあるサンプルを参照してください。
|
この項では、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で入手できます。
Oracle User Messaging Serviceの電子メール・ドライバを有効にしてアウトバウンド・メッセージングおよびステータスの取得を実行するには、電子メール・ドライバを構成する際、SMTPメール・サーバーの名前をOutgoingMailServer
プロパティ値として入力します。
電子メール・ドライバの構成の詳細は、『Oracle User Messaging Serviceの管理』を参照してください。
注意: このサンプル・アプリケーションは汎用的であるため、適切なメッセージング・ドライバがデプロイされて構成されている場合は、他のチャネル経由のアウトバウンド・メッセージングもサポートできます。 |
この項では、Windowsベース・ビルドのJDeveloperを使用して、usermessagingsampleを作成、コンパイルおよびデプロイする手順を説明します。
Oracle JDeveloperで、usermessagingsample.jws
(usermessagingsample-src.zipファイルに含まれています)を開きます。
Oracle JDeveloperのメイン・ウィンドウにプロジェクトが表示されます。
サンプル・アプリケーションを作成するには、WebモジュールにOracle UMSクライアント・ライブラリを含める必要があります。
「アプリケーション・ナビゲータ」で、Webモジュール「usermessagingsample-web」を右クリックし、「プロジェクト・プロパティ」を選択します。
左側のペインで、「ライブラリとクラスパス」を選択します。
「OK」をクリックします。
usermessagingsample-webプロジェクトの下にあるJavaファイルを検索し、メッセージング・クライアントAPIを使用してメッセージの送信、ステータスの取得およびメッセージの同期受信を実行する方法を確認します。MessagingClientインスタンスは、プロジェクトのSampleUtils.java
に作成されます。
アプリケーションをデプロイする手順は、次のとおりです。
ナビゲーション・ペインでアプリケーションを右クリックし、「新規」を選択して、アプリケーション・サーバー接続を作成します。第A.3項「新規アプリケーション・サーバー接続の作成」の説明に従います。
アプリケーションをデプロイするには、「usermessagingsample application」→「デプロイ」→「usermessagingsample」→「デプロイ先」→「ums_server」の順に選択します。
メッセージBuild Successful
がログに表示されていることを確認します。
メッセージDeployment Finished
がデプロイメント・ログに表示されていることを確認します。
アプリケーションが正常にデプロイされました。
サンプルを実行するには、その前に、Oracle User Messaging Serviceの追加ドライバを構成し、必要に応じて、ユーザー通信プリファレンスでメッセージを受信するユーザー用のデフォルト・デバイスを構成する必要があります。
注意: 詳細は、『Oracle User Messaging Serviceの管理』を参照してください。 |
Oracle WebLogic Serverの実行中のインスタンスにusermessagingsampleをデプロイした後は、次の手順を実行します。
Webブラウザを起動し、サンプル・アプリケーションのアドレスをhttp://
host
:http-port
/usermessagingsample/
と入力します。たとえば、ブラウザのナビゲーション・バーにhttp://localhost:7001/usermessagingsample/
と入力します。
プロンプトが表示された場合は、ログイン資格証明を入力します。たとえば、ユーザー名はweblogic
と入力します。メッセージ・サンプルをテストするためのブラウザ・ページが表示されます(図A-3)。
サンプル・メッセージの送信をクリックします。「メッセージの送信」ページが表示されます(図A-4)。
(オプション)送信者アドレスを次の書式で入力します。
Email:
sender_address
たとえば、Email:sender@example.com
と入力します。
受信者アドレスを1つ以上入力します。たとえば、Email:recipient@example.com
と入力します。複数のアドレスを入力する場合は、次のようにカンマ区切りリストで入力します。
Email:
recipient_address1
,
Email:
recipient_address2
ユーザー通信プリファレンスを構成している場合、メッセージのアドレスは単にUser:
username
と指定できます。たとえば、User:weblogic
と入力します。
(オプション)件名、つまり電子メールの内容を入力します。
「送信」をクリックします。「メッセージ・ステータス」ページが表示され、トランザクションの進捗が表示されます(図A-5には、メッセージング・エンジンが受信して処理するメッセージが表示されています)。
リフレッシュをクリックしてステータスを更新します。電子メール・メッセージが電子メール・サーバーに配信されると、図A-6に示すように、ステータスの内容フィールドに「リモート・ゲートウェイへのアウトバウンド・メッセージの配信に成功しました。」と表示されます。
この項では、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
を例にして、非同期のインバウンドおよびアウトバウンド・メッセージング機能を持つアプリケーションの作成プロセスを説明します。
Oracle User Messaging Serviceの電子メール・ドライバを有効にしてインバウンドやアウトバウンド・メッセージングおよびステータスの取得を実行するには、電子メール・ドライバを次のように構成します。
OutgoingMailServerプロパティの値として、SMTPメール・サーバーの名前を入力します。
IncomingMailServerプロパティの値として、IMAP4/POP3メール・サーバーの名前を入力します。受信ユーザー名とパスワードも構成します。
電子メール・ドライバの構成の詳細は、『Oracle Fusion Middleware Oracle User Messaging Serviceの管理』の電子メール・ドライバの構成に関する項を参照してください。
注意: このサンプル・アプリケーションは汎用的であるため、適切なメッセージング・ドライバがデプロイされて構成されている場合は、他のチャネル経由のインバウンドおよびアウトバウンド・メッセージングもサポートできます。 |
この項では、Windowsベース・ビルドのJDeveloperを使用して、usermessagingsample-echoを作成、コンパイルおよびデプロイする手順を説明します。
usermessagingsample-echo-src.zip
をJDEV_HOME
/communications/
samples/
ディレクトリに解凍します。共有ライブラリ参照をプロジェクトで有効にするには、このディレクトリを使用する必要があります。
注意: 別のディレクトリを使用する場合は、oracle.sdp.messaging ライブラリ・ソース・パスをJDEV_HOME / communications/modules/oracle.sdp.messaging_12.1.3 /sdpmessaging.jar に更新する必要があります。 |
Oracle JDeveloperで、usermessagingsample-echo.jws
(.zipファイルに含まれています)を開きます(図A-7)。
Oracle JDeveloperのメイン・ウィンドウにプロジェクトが表示されます(図A-8)。
次のライブラリがusermessagingsample-echo-web
モジュールに追加されていることを確認して、サンプル・アプリケーションのビルド依存性が満たされていることを確認します。
ライブラリ: oracle.sdp.messaging、クラスパス: JDEV_HOME
/
communications/modules/oracle.sdp.messaging_12.1.3/
sdpmessaging.jar
。これはJavaライブラリで、UMS、およびUMSを使用してメッセージを送受信するアプリケーションで使用されます。
各モジュールに対して次の手順を実行します。
「アプリケーション・ナビゲータ」で、モジュールを右クリックし、「プロジェクト・プロパティ」を選択します。
左側のペインで、「ライブラリとクラスパス」を選択します(図A-9)。
「OK」をクリックします。
usermessagingsample-echo-webプロジェクトの下にあるJavaファイルを検索し、メッセージング・クライアントAPIを使用してアクセスを登録および登録解除する方法、およびEchoListener
を使用してメッセージを非同期で受信する方法を確認します。
アプリケーションをデプロイする手順は、次のとおりです。
ナビゲーション・ペインでアプリケーションを右クリックし、「新規」を選択して、アプリケーション・サーバー接続を作成します。第A.3項「新規アプリケーション・サーバー接続の作成」の説明に従います。
アプリケーションをデプロイするには、「usermessagingsample-echo application」→「デプロイ」→「usermessagingsample-echo」→「デプロイ先」→「ums_server」の順に選択します。
メッセージBuild Successful
がログに表示されていることを確認します。
メッセージDeployment Finished
がデプロイメント・ログに表示されていることを確認します。
アプリケーションが正常にデプロイされました。
サンプルを実行するには、その前に、Oracle User Messaging Serviceの追加ドライバを構成し、必要に応じて、ユーザー通信プリファレンスでメッセージを受信するユーザー用のデフォルト・デバイスを構成する必要があります。
注意: 詳細は、『Oracle User Messaging Serviceによるアプリケーションの開発』を参照してください。 |
Oracle WebLogic Serverの実行中のインスタンスにusermessagingsample-echoをデプロイした後は、次の手順を実行します。
Webブラウザを起動し、サンプル・アプリケーションのアドレスをhttp://
host
:
http-port
/usermessagingsample-echo/
と入力します。たとえば、ブラウザのナビゲーション・バーにhttp://localhost:7001/usermessagingsample-echo/
と入力します。
プロンプトが表示された場合は、ログイン資格証明を入力します。たとえば、ユーザー名はweblogic
と入力します。メッセージ・サンプルをテストするためのブラウザ・ページが表示されます(図A-10)。
アクセスの登録/登録解除をクリックします。アクセス登録ページが表示されます(図A-11)。
アクセスのアドレスを次の書式で入力します。
EMAIL:
server_address
たとえば、EMAIL:myserver@example.com
と入力します。
アクションとして登録を選択し、送信をクリックします。登録ステータス・ページが表示され、図A-12に示すように「登録済」と表示されます。
メッセージ・クライアント(電子メールの場合は電子メール・クライアント)から、前の手順でアクセスとして登録したアドレスに、メッセージを送信します。
該当するチャネル用のUMSメッセージング・ドライバが正しく構成されている場合は、usermessagingsample-echoアプリケーションから戻されるエコー・メッセージを受信できるはずです。
Oracle JDeveloperでアプリケーション・サーバー接続を定義し、アプリケーションをデプロイおよび実行します。次の手順を実行し、アプリケーション・サーバー接続を作成します。
プロジェクトを右クリックし、「新規」を選択します。コンテキスト・メニューから「ギャラリから」を選択します。「新規ギャラリ」ウィンドウの左側のペインで「接続」に移動し、項目リストから「アプリケーション・サーバー接続」を選択します。
「OK」をクリックします。
「接続名」フィールドで、サーバー接続名(SOA_serverなど)を入力し、「次へ」をクリックします。
「接続タイプ」ドロップダウン・リストから「WebLogic 12.x」を選択します。
「認証」画面で、アプリケーション・サーバーの管理者のユーザー名とパスワードを入力します。「次へ」をクリックします。
「構成」画面で、WebLogic Serverのホスト名、ポート、SSLポートおよびドメイン名を入力します。「次へ」をクリックします。
「テスト」画面で、「接続のテスト」をクリックし、接続を検証します。テストが成功すると、確認メッセージが表示されます。「終了」をクリックします。
アプリケーション・サーバー接続が作成されました。
この項では、OTNでOracle User Messaging Serviceが提供するWebサービスAPIを使用して、サンプル・チャット・アプリケーションを作成、デプロイおよび実行する方法を説明します。
注意: Oracle User Messaging Serviceのコード・サンプルに関する詳細を参照したり、サンプルを自分で実行するには、次の場所にあるサンプルを参照してください。
|
この節では、以下のトピックについて説明します。
このサンプルは、電子メール、SMSまたはIMを通じてメッセージを送受信するWebベースのチャット・アプリケーションの作成方法を示します。このサンプルでは、サービスWebサービスAPIを使用してユーザー・メッセージング・サーバーと相互作用します。Oracle JDeveloperでアプリケーション・サーバー接続を定義し、アプリケーションをデプロイおよび実行します。
このアプリケーションは、単純なWebチャット・インタフェースが含まれる、事前作成されたOracle JDeveloperプロジェクトとして提供されます。
注意: このサンプルが動作するには、UMSサーバーが使用でき、必要なドライバにより適切に構成されている必要があります。 |
次の手順を実行して、事前作成されたサンプル・アプリケーションを実行し、デプロイします。
usermessagingsample-ws-src.zip
を抽出し、usermessagingsample-ws.jwsをOracle JDeveloperで開きます。
Oracle JDeveloperのメイン・ウィンドウにプロジェクトが表示されます。
このアプリケーションには、1つのWebモジュールが含まれています。アプリケーションのソース・コードはすべて設定済です。
WebモジュールでOracle UMS Client
ライブラリが使用されていることを確認して、サンプル・アプリケーションのビルド依存性を満たします。
「アプリケーション・ナビゲータ」で、Webモジュール「usermessagingsample-ws-war
」を右クリックし、「プロジェクト・プロパティ」を選択します。
左側のペインで、「ライブラリとクラスパス」を選択します。
「OK」をクリックします。
ナビゲーション・ペインでプロジェクトを右クリックし、「新規」を選択して、アプリケーション・サーバー接続を作成します。第A.4.4項「新規アプリケーション・サーバー接続の作成」の説明に従います。
プロジェクトをデプロイするには、「usermessasgingsample-ws project」→「デプロイ」→「usermessasgingsample-ws」→「デプロイ先」→「ums_server」の順に選択します。
メッセージBuild Successful
がログに表示されていることを確認します。
メッセージDeployment Finished
がデプロイメント・ログに表示されていることを確認します。
アプリケーションが正常にデプロイされました。
次の手順を実行し、サンプルを実行およびテストします。
Webブラウザを開きます。
次のようにアプリケーションのURLに移動し、ログインします。
http://
host
:
port
/usermessagingsample-ws/
メッセージングWebサービス・サンプルWebページが表示されます(図A-16)。このページには、ナビゲーション・タブ、およびアプリケーションの手順が表示されます。
「構成」をクリックして、次の値を入力します(図A-17)。
Webサービスのエンドポイントを指定します。例: http://example.com:8001/ucs/messaging/webservice
ユーザー名とパスワードを指定します。
ポリシーを指定します(ユーザー・メッセージング・サービスのインスタンスでWS-Securityが有効になっている場合に必要)。
「保存」をクリックします。
「管理」をクリックします。
メッセージを受信するアドレスおよびオプションのキーワードを入力します(図A-18)。
「開始」をクリックします。
メッセージRegistration operation succeeded
が表示されていることを確認します。
「チャット」をクリックします。
「至」フィールドに受信者を入力します。
メッセージを入力します。
「送信」をクリックします。
メッセージが受信されていることを確認します。
Oracle JDeveloperでアプリケーション・サーバー接続を定義し、アプリケーションをデプロイおよび実行します。第A.3項「新規アプリケーション・サーバー接続の作成」の手順を実行し、アプリケーション・サーバー接続を作成します。