| Oracle® Fusion Middleware Oracle WebLogic Server 12.1.3 JMSリソース・アダプタの管理 12c (12.1.3) E56272-02 |
|
![]() 前 |
![]() 次 |
この章では、WebLogic Server 12.1.3において、外部アプリケーション・サーバーでWebLogic JMSメッセージをインバウンド・メッセージとして非同期に消費するためのMDBを構成するように、JMS RAのra.xmlファイルを構成する方法について説明します。
この章には次の項が含まれます:
WebLogic宛先からのメッセージを非同期に消費するためのMDBを必要とするアプリケーションでは、JMS RAのインバウンド実装を使用します。MDBの動作は、アプリケーションをデプロイする前に、次のファイルのプロパティ値を構成することによって決定されます。
次の項では、ra.xmlファイルでインバウンド構成のinbound-resourceadapterプロパティを定義する方法について説明します。
必須のinbound-resourceadapterプロパティは、WebLogic Server環境にあるWebLogic JMSリソース・アダプタのra.xmlファイルで指定されます。詳細は、「WebLogic Server環境でのJMS RAの場所」を参照してください。
必須のJMSプロパティには次のものがあります。
ConnectionFactory
destination
destinationType
ConnectionFactory、destinationおよびdestinationTypeの値は、ejb-jar.xmlファイルのactivation-configプロパティとして定義されます。また、ejb-jar.xmlで構成されたJNDI名は、connection-definitionおよびadminobject要素のJMS RA値に割り当てられたJNDI名にマッピングする必要があります。参照:
JMS RAでは、その他多数のactivation-configプロパティがサポートされています。詳細は、「ejb-jar.xmlファイルでのactivation-configプロパティの構成」および「JMS RAのインバウンド・プロパティ」を参照してください。
次のコード例は、inbound-resourceadapter構成を示しています。
例5-1 inbound-resourceadapterの構成例
. . .
<inbound-resourceadapter>
<messageadapter>
<messagelistener>
<messagelistener-type>
javax.jms.MessageListener
</messagelistener-type>
<activationspec>
<activationspec-class>
weblogic.jms.ra.ActivationSpecImpl
</activationspec-class>
<required-config-property>
<config-property-name>ConnectionFactory</config-property-name>
</required-config-property>
<required-config-property>
<config-property-name>Destination</config-property-name>
</required-config-property>
<required-config-property>
<config-property-name>DestinationType</config-property-name>
</required-config-property>
</activationspec>
</messagelistener>
</messageadapter>
</inbound-resourceadapter>
. . .
次の項では、ejb-jar.xmlファイルでactivation-configプロパティを構成する方法について説明します。
ejb-jar.xmlの要素については、http://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsdでスキーマを参照してください。
EJB 3.0以降、ejb-jar.xmlはオプションです。注釈を使用すると、ディスクリプタ要素のかわりにメタデータを宣言できます。詳細は、『Oracle Fusion Middleware Oracle WebLogic ServerメッセージドリブンBeanの開発』のEJB 3.1に準拠したMDBの使用に関する項を参照してください。
ra.xmlのinbound-resourceadapterのすべてのrequired-config-propertyプロパティに、activation-config-propertyプロパティを構成する必要があります。
一般的な必須のJMSプロパティには次のものがあります。
ConnectionFactory: JMSコネクタの接続ファクトリのJNDIロケーション。
destination: JMSコネクタの宛先のJNDIロケーション。
destinationTypeは、次のいずれかのタイプになります。
javax.jms.Topic
javax.jms.Queue
javax.jms.Destination
また、MDBアプリケーションがオプションのactivation-configプロパティを使用している場合は、外部アプリケーション・サーバーで、これらのオプションのactivation-configプロパティがra.xmlにrequired-config-property要素として定義されている必要がある場合があります。アプリケーション・サーバーのベンダーが提供するドキュメントで確認してください。
次の例は、キューの構成のactivation-configプロパティを示しています。この例では、MDBは、JNDI名wljmsra/xacfを持つ接続ファクトリからの接続を使用して、JNDI名wljmsra/queueを持つキューからメッセージをデキューします。
. . .
<activation-config-property>
<activation-config-property-name>
ConnectionFactory
</activation-config-property-name>
<activation-config-property-value>
wljmsra/xacf
</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>
Destination
</activation-config-property-name>
<activation-config-property-value>
wljmsra/queue
</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>
DestinationType
</activation-config-property-name>
<activation-config-property-value>
javax.jms.Queue
</activation-config-property-value>
</activation-config-property>
. . .
次の例は、トピックの構成のactivation-configプロパティを示しています。この例では、MDBは、JNDI名wljmsra/txacf1を持つ接続ファクトリからの接続を使用して、JNDI名wljmsra/pdtopic1を持つトピックからメッセージをデキューします。
. . .
<activation-config-property>
<activation-config-property-name>
ConnectionFactory
</activation-config-property-name>
<activation-config-property-value>
wljmsra/txacf1
</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>
Destination
</activation-config-property-name>
<activation-config-property-value>
wljmsra/pdtopic1
</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>
DestinationType
</activation-config-property-name>
<activation-config-property-value>
javax.jms.Topic
</activation-config-property-value>
</activation-config-property>
. . .
使用環境に合った適切なMDB動作を実行するのに必要な追加プロパティを構成します。詳細は、「JMS RAのインバウンド・プロパティ」を参照してください。
次の例は、JMS RA activation-configプロパティを含むejb-jar.xmlファイルを示しています。
例5-2 JMS RA activation-configプロパティを含むejb-jar.xmlファイル
<?xml version="1.0" encoding="UTF-8"?>
<ejb-jar xmlns="http://java.sun.com/xml/ns/javaee">
<display-name>WebLogic RA Demo</display-name>
<enterprise-beans>
<message-driven>
<display-name>My queue MDB</display-name>
<ejb-name>queueMDB</ejb-name>
<ejb-class>jms.ra.DisQueueMDB</ejb-class>
<messaging-type>javax.jms.MessageListener</messaging-type>
<transaction-type>Container</transaction-type>
<activation-config>
<activation-config-property>
<activation-config-property-name>
ConnectionFactory
</activation-config-property-name>
<activation-config-property-value>
java:sample/factory
</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>
Destination
</activation-config-property-name>
<activation-config-property-value>
java:sample/destination/queue
</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>
DestinationType
</activation-config-property-name>
<activation-config-property-value>
javax.jms.Queue
</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>UserName</activation-config-property-name>
<activation-config-property-value></activation-config-property-value> </activation-config-property>
<activation-config-property>
<activation-config-property-name>Password</activation-config-property-name>
<activation-config-property-value></activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>ClientId</activation-config-property-name>
<activation-config-property-value>queueMDB</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>MessageSelector</activation-config-property-name>
<activation-config-property-value></activation-config-property-value>
</activation-config-property>
</activation-config>
</message-driven>
. . .
</message-driven>
</enterprise-beans>
. . .
</ejb-jar>
その他のejb-xml.jarファイルの例については、WebLogic Server環境のリソース・アダプタの例を確認してください。
JMS RAでは、インバウンド・メッセージを消費するMDBによって使用される宛先のスレッドを管理するために、3つのプロパティを提供しています。
minListenerThreads: 個々の物理宛先に対して作成されるリスナー・スレッドの最小数。「minListenerThreads」を参照してください。
maxTotalListenerThreads: 宛先に使用できるリスナー・スレッドの最大数。「maxTotalListenerThreads」を参照してください。
maxListenerThreads: 宛先内の個々の物理宛先に対して作成されるリスナー・スレッドの最大数。「maxListenerThreads」を参照してください。
この項では、宛先のスレッドの最大数(maxListenerThreads)を構成する方法について説明します。
キュー: 2つ以上のスレッドを使用すると、メッセージが消費される速度の向上に役立つ場合があります。
トピック: この値は常に1に設定する必要があります。各リスナー・スレッドは、独自のセッションとTopicSubscriberを取得します。
恒久サブスクライバ: 同じサブスクリプション名のサブスクライバを複数持つとエラーになります。
非恒久サブスクライバ: この値は常に1に設定する必要があります。スレッドを増加すると、サブスクライバが増加し、処理する各メッセージのコピーも増加することになります。
maxTotalListenerThreadsプロパティを使用すると、分散宛先のスレッドの追加の処理を制限したり指定することができます。
maxTotalListenerThreadsの値が関連付けられている分散宛先内の物理宛先の数より小さい場合、JMS RAは、分散宛先内の物理宛先の数と同じ値を使用し、警告メッセージを記録します。
外部アプリケーション・サーバーが分散宛先内の物理宛先の数以上のスレッドを指定できない場合、JMS RAは警告メッセージを記録します。
JMS RAでは、スレッドを割り当てるための公平性ポリシーを実装しているので、maxListenerThreadsより小さい数が現在設定され、より多くのスレッドを必要としている個々の物理宛先は、同じ分散宛先内の他の物理宛先(少なくともさらに2つ多いスレッドを持つ)からスレッドを再割当てできます。この公平性ポリシーは、外部アプリケーション・サーバーのWorkManager (JMS RAによるmaxTotalListenerThreadsでの新規スレッドの追加リクエストを許可しない)からは独立しています。
スレッド不足の決定および既存のスレッドのみの転送の両方が、メッセージの処理中(onMessageのコール中)に行われるため、ある宛先から別の宛先へのスレッドの再割当てのプロセスには時間がかかります。2つのスレッドが含まれているため、転送プロセスは2つ分のonMessage処理時間がかかります。
JMS RAを使用すると、ユーザーはインバウンド通信の例外キューを構成して、インバウンドMDBキューのポイズン・メッセージを処理できます。UseExceptionQueue=trueの場合、他の場合には破棄されてしまうメッセージが例外キューに送信されます。メッセージは通常、maxDeliveryCount値を超えた場合に、例外キューに送信されます。「maxDeliveryCount」を参照してください。
メッセージは、次のルールを使用して例外キューへ処理されます。
メッセージは、例外キューに直接設定されません。
同じタイプの新しいメッセージが作成されます。
元のメッセージのプロパティおよびボディが新しいメッセージにコピーされます。
リソース・プロバイダによって元のヘッダーがオーバーライドされないようにするために、それぞれがGJRA_CopyOfJMS{Header}プロパティにコピーされます。javax.jms.Destinationは有効なプロパティ・タイプではないため、各宛先ヘッダーは説明メッセージに変換されます。注意: JMSX*プロパティは変換されません。たとえば、JMSXDeliveryCountのようになります。
|
注意: コピー・プロセスの一部が失敗した場合、次のルールを使用して処理は続行されます。Bytes、MapおよびStreamメッセージ・タイプでは、メッセージ・ボディの一部がコピーされ、残りはコピーされないことがあります。 |
コピー・プロセスが100%成功したら、値trueが設定されたブール・プロパティGJRA_CopySuccessfulが追加されます。
メッセージが配信されなかった理由を示す、GJRA_DeliveryFailureReasonという文字列プロパティが追加されます。
配信障害の直前にMDBのonMessageメソッドが例外を生成した場合、例外情報を含むGJRA_onMessageExceptionsという文字列プロパティが追加されます。
元のメッセージのコピーが例外キューに送信されます。
|
注意: 例外キューへの元のメッセージのコピーの送信は、1回のみ試行されます。この試行に失敗すると、メッセージは例外キューに配置されることなく破棄されます。詳細は、includeBodiesInExceptionQueueを参照してください。 |
プライマリ宛先に使用される接続ファクトリは、例外キューに対しても使用されます。(Destinationプロパティで指定された)プライマリ宛先がトピックの場合、接続ファクトリはキューとトピックの両方をサポートしている必要があります。たとえば、<connectionfactory-interface>要素はjavax.jms.ConnectionFactoryまたはjavax.jms.XAConnectionFactoryのいずれかである必要があります。
userNameおよびpasswordプロパティを使用すると、リソース・プロバイダに認証パラメータを渡すことができます。これらのプロパティのどちらも設定されていない場合、このMDBのインバウンド・メッセージ処理に使用される接続が、引数なしのcreateConnectionメソッドを使用して作成されます。これらのいずれかまたは両方が設定されている場合、userNameまたはpasswordプロパティ、あるいはその両方が、ユーザーまたはパスワードの引数としてcreateConnectionメソッドに渡されます。これらのいずれか1つのみが設定されている場合、createConnection引数リストのそのプロパティ値にかわってnullが使用されます。
次の項では、インバウンド・メッセージに対して詳細なメッセージ処理を構成する方法について説明します。
JMS RAは、インバウンド・メッセージの処理時に、SHARABLEサブスクリプション共有ポリシーとUNRESTRICTEDクライアントIDポリシーを使用して、構成された接続ファクトリの設定をオーバーライドします。JMS RAのMDBはサブスクリプション名を生成しないため、恒久サブスクリプションにはsubscriptionNameを指定する必要があります。サブスクリプションは次の場合に共有されます。
非恒久: 同じ分散トピック上のコンシューマは、同じclientIDとmessageSelectorを持つ場合にのみ、非恒久サブスクリプションを共有できます。
恒久: 同じ分散トピック上のコンシューマは、同じclientID、メッセージ・セレクタおよびsubscriptionNameを持つ場合にのみ、恒久サブスクリプションを共有できます。
MDBが着信メッセージを消費していることを確認するために、常にclientIdを構成します。たとえば、次のように構成します。
. . .
<activation-config>
<activation-config-property>
<activation-config-property-name>clientId</activation-config-property-name>
<activation-config-property-value>myMDB</activation-config-property-value>
</activation-config-property>
</activation-config>
. . .
詳細は、Oracle Fusion Middleware Oracle WebLogic Server JMSリソースの管理の共有サブスクリプションの構成に関する項を参照してください。
アプリケーションでサブスクリプション・メッセージの単一スレッド式処理が必要な場合は、WebLogic JMSの順序単位(UOO)処理を使用するようアプリケーションを構成します。詳細は、『Oracle Fusion Middleware Oracle WebLogic Server JMSアプリケーションの開発.』の順序単位のメッセージの使用に関する項を参照してください。
次の項では、分散トピックを使用して高可用性アプリケーションを開発する際に使用できる設計戦略について説明します。
この項では、レプリケートされた分散トピックとパーティション化された分散トピック(どちらもインバウンド・メッセージの消費でサポートされている)の概要について説明します。
レプリケートされた分散トピック: すべての物理トピック・メンバーが送信された各メッセージを受信します。メッセージがいずれかの物理トピック・メンバーに届くと、そのメッセージのコピーが同じトピック内の他のメンバーに自動的に内部で転送されます。
パーティション化された分散トピック: メッセージを受信する分散トピック・メンバーは、メッセージを認識するメンバーのみです。メッセージは他のメンバーには転送されず、他のメンバーのサブスクライバはメッセージのコピーを受信しません。着信メッセージは、JMS AffinityおよびLoad Balance属性を使用して、分散トピック・メンバー間でロード・バランシングできます。詳細は、Oracle Fusion Middleware Oracle WebLogic Server JMSリソースの管理のパーティション化された分散トピックのロード・バランシングに関する項を参照してください。
One-Copy-Per-Applicationは、使用可能なデフォルトの設計パターンで、次の特徴があります。
各アプリケーションが全体として(つまり、アプリケーションのすべてのインスタンスを一緒に)、DTにパブリッシュされた各メッセージのコピーを1つ受信します。つまり、各インスタンスはDTに送信されたメッセージのサブセットのみを受信します。
クライアントIDポリシーはUNRESTRICTEDです。
サブスクリプション共有ポリシーはSHARABLEです。
サブスクライバが恒久の場合は、同じサブスクリプション名を使用します。
すべてのコンシューマが同じトピック・インスタンス(またはDTのメンバー)にサブスクライブします。
One-Copy-Per-Application設計戦略を実装するには、「One-Copy-Per-ApplicationのEJB構成の例」に示すように、activation-config要素にTopicMessageDistributionMode=One-Copy-Per-Applicationの値を持つ、ProviderPropertiesプロパティをEJBで指定する必要があります。
|
注意: TopicMessageDistributionMode=One-Copy-Per-Serverを指定しない場合は、JMS RAではメッセージの重複を避けるために、デフォルトでTopicMessageDistributionMode=One-Copy-Per-Applicationに設定されます。 |
ejb-jar.xmlファイルからの次のコード・スニペットは、One-Copy-Per-Applicationメッセージ処理を実装しています。
. . .
<mdb-resource-adapter>
<resource-adapter-mid>wljmsra</resource-adapter-mid>
<activation-config>
<activation-config-property>
<activation-config-property-name>ClientId</activation-config-property-name>
<activation-config-property-value>RDT2MDB</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>ProviderProperties</activation-config-property-name>
<activation-config-property-value>TopicMessageDistributionMode=One-Copy-Per-Application</activation-config-property-value>
</activation-config-property>
</activation-config>
</mdb-resource-adapter>
<!-- Mapping a Queue admin-object to the Resource-Adapter name -->
<resource-env-ref>
<resource-env-ref-name>jms/ResultTopic</resource-env-ref-name>
<jndi-name>wljmsra/rtopic1</jndi-name>
</resource-env-ref>
<!-- Mapping a Connection Factory to the Resource-Adapter name -->
<resource-ref>
<res-ref-name>jms/ResultXACFFactory</res-ref-name>
<jndi-name>wljmsra/xacf</jndi-name>
</resource-ref>
. . .
One-Copy-Per-Serverは、アプリケーションの各インスタンスが、トピックにパブリッシュされた各メッセージのコピーを1つ受信する設計パターンです。
One-Copy-Per-Server設計戦略を実装するには、次のことを行う必要があります。
外部サーバー・インスタンスの起動時に、weblogic.jms.ra.providers.wl.ServerIDプロパティを指定します。たとえば、-Dweblogic.jms.ra.providers.wl.ServerID=aUniqueIdForTheServerのように指定します。
ここで、aUniqueIdForTheServerは外部サーバーの一意の識別子です。
Oracle Glassfishの場合、asadminコマンドを使用して、このプロパティを構成できます。
asadmin> create-jvm-options --user myUsername --password myPassword --host localhost --port 4848 -Dweblogic.jms.ra.providers.wl.ServerID="aUniqueIdForTheServer"
「One-Copy-Per-ApplicationのEJB構成の例」に示すように、activation-config要素にTopicMessageDistributionMode=One-Copy-Per-Serverの値を持つ、ProviderPropertiesプロパティをEJBで指定します。
ejb-jar.xmlファイルからの次のコード・スニペットは、One-Copy-Per-Serverメッセージ処理を実装しています。
. . .
<mdb-resource-adapter>
<resource-adapter-mid>wljmsra</resource-adapter-mid>
<activation-config>
<activation-config-property>
<activation-config-property-name>ClientId</activation-config-property-name>
<activation-config-property-value>RDTMDB</activation-config-property-value>
</activation-config-property>
<activation-config-property>
<activation-config-property-name>ProviderProperties</activation-config-property-name>
<activation-config-property-value>TopicMessageDistributionMode=One-Copy-Per-Server</activation-config-property-value>
</activation-config-property>
</activation-config>
</mdb-resource-adapter>
<!-- Mapping a Queue admin-object to the Resource-Adapter name -->
<resource-env-ref>
<resource-env-ref-name>jms/ResultTopic</resource-env-ref-name>
<jndi-name>wljmsra/rtopic1</jndi-name>
</resource-env-ref>
<!-- Mapping a Connection Factory to the Resource-Adapter name -->
<resource-ref>
<res-ref-name>jms/ResultXACFFactory</res-ref-name>
<jndi-name>wljmsra/xacf</jndi-name>
</resource-ref>
. . .
MDBアプリケーションをホストする各外部アプリケーション・サーバー・インスタンスでは、トピックが同じクラスタ内または異なるクラスタ内のどちらで実行されているかに関係なく、トピックに対してMDBプールが作成されます。N個のノードのMDBクラスタでは、N個のMDBプールが作成されます。各MDBプールはトピック上に個別のサブスクリプションを作成し、異なるMDBプールからのサブスクライバは同じサブスクリプションを共有しません。詳細は、「One-Copy-Per-Serverの実装」を参照してください。
この項では、インバウンド通信用のJMS RAのチューニングおよびベスト・プラクティスについて説明します。
JMS RAで分散宛先メンバーより多いスレッドが割り当てられていることを確認します。
トピックの使用時には、常にclientIDを構成します。JMS RAは、インバウンド・メッセージの処理時に、恒久サブスクライバまたは非恒久サブスクライバに対して構成されたclientIdを必要とする、SHARABLEサブスクリプション共有ポリシーを使用します。
clientIDが設定されていない場合、MDBは、外部アプリケーション・サーバー・ログに記録されたメッセージおよびエラー条件を受信しません。詳細は、「JMS RAと共有可能なサブスクリプション」を参照してください。
キューの場合、maxListenerThreadsの値を2つ以上のスレッドに増やすと、メッセージが消費される速度が向上する可能性があります。
JMS RAでは、共有可能な接続はサポートされていません。アプリケーションのJEEディスクリプタ(web.xml、ejb-jar.xml)の<resource-ref>要素を使用して、そのアプリケーションでルックアップして使用されるJMS接続ファクトリを識別する場合、<res-sharing-scope>子要素をunsharableに設定する必要があります。この要素のデフォルト値はsharableです。たとえば、次のように構成します。
. . .
<resource-ref>
<res-ref-name>jms/ReplyFactory</res-ref-name>
<res-type>javax.jms.ConnectionFactory</res-type>
<res-auth>Application</res-auth>
<res-sharing-scope>unsharable</res-sharing-scope>
</resource-ref>
アプリケーションで@Resourceインジェクションが使用されている場合は、http://docs.oracle.com/javaee/6/api/javax/annotation/Resource.html#shareable%28%29を参照してください。