AMQ Broker の設定

1. 現在、ブローカーは仮想ホストをサポートしません。つまり、host フレーム の CONNECT ヘッダーは無視されます。
2. メッセージ確認応答はトランザクションではありません。ACK フレームはトランザクションの一部にできず、transaction ヘッダーが設定されている場合は無視されます。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。
2. 以下の例のように、STOMP 接続に使用される acceptor の stompEnableMessageId パラメーターを true に設定します。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。
2. 以下の例のように、STOMP 接続に使用される acceptor の URI に connectionTTL パラメーターを追加します。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。
2. connection-ttl-override 属性を追加し、新しいデフォルトの値をミリ秒単位で指定します。以下のように、<core> スタンザに属します。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 以下の例のように、<wildcard-addresses> セクションを設定に追加します。

   <configuration>
     <core>
       ...
       <wildcard-addresses> //
         <enabled>true</enabled> //
         <delimiter>,</delimiter> //
         <any-words>@</any-words> //
         <single-word>$</single-word>
       </wildcard-addresses>
       ...
     </core>
   </configuration>

   enabled

   true に設定すると、カスタム設定を使用するようにブローカーに指示します。

   delimiter

   デフォルトの . の代わりに delimiter として使用するカスタム文字を指定します 。

   any-words

   any-words の値として提供された文字は、ゼロ以上の単語のシーケンスに一致し、デフォルトの # を置き換えます。式の最後にこの文字を使用します。

   single-word

   single-word の値として提供された文字は、単一の単語の照合に使用され、デフォルトの * を置き換えます。この文字は式内の任意の場所を使用します。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. address の選択された queue エレメントの周りに、anycast 設定エレメントをラップします。address 要素と queue 要素の両方の name 属性の値が同じであることを確認します。以下に例を示します。

   <configuration ...>
     <core ...>
       ...
       <address name="my.anycast.destination">
         <anycast>
           <queue name="my.anycast.destination"/>
         </anycast>
       </address>
     </core>
   </configuration>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. address 要素の queue 要素で anycast 設定要素をラップします。以下に例を示します。

   <configuration ...>
     <core ...>
       ...
       <address name="my.anycast.destination">
         <anycast>
           <queue name="q1"/>
           <queue name="q2"/>
         </anycast>
       </address>
     </core>
   </configuration>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 選択した キューに 永続 設定要素を追加します。true の値を設定します。

   <configuration ...>
     <core ...>
       ...
       <address name="my.durable.address">
         <multicast>
           <queue name="q1">
             <durable>true</durable>
           </queue>
         </multicast>
       </address>
     </core>
   </configuration>

   注記

   キューはデフォルトで永続性があるため、永続性のあるキューを作成するために、durable 要素を含めて値を true に設定することは、厳密には必要ありません。ただし、要素を明示的に含むと、必要に応じてキューの動作を非永続状態に後で変更できます。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 選択された各キューに durable 設定要素を追加します。true の値を設定します。

   <configuration ...>
     <core ...>
       ...
       <address name="my.non.shared.durable.address">
         <multicast>
           <queue name="orders1">
             <durable>true</durable>
           </queue>
           <queue name="orders2">
             <durable>true</durable>
           </queue>
         </multicast>
       </address>
     </core>
   </configuration>

   注記

   キューはデフォルトで永続性があるため、永続性のあるキューを作成するために、durable 要素を含めて値を true に設定することは、厳密には必要ありません。ただし、要素を明示的に含むと、必要に応じてキューの動作を非永続状態に後で変更できます。

3. 選択した各キューに max-consumers 属性を追加します。1 の値を設定します。

   <configuration ...>
     <core ...>
       ...
       <address name="my.non.shared.durable.address">
         <multicast>
           <queue name="orders1" max-consumers="1">
             <durable>true</durable>
           </queue>
           <queue name="orders2" max-consumers="1">
             <durable>true</durable>
           </queue>
         </multicast>
       </address>
     </core>
   </configuration>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 選択した各キューに purge-on-no-consumers 属性を追加します。true の値を設定します。

   <configuration ...>
     <core ...>
       ...
       <address name="my.non.durable.address">
           <multicast>
               <queue name="orders1" purge-on-no-consumers="true"/>
           </multicast>
       </address>
     </core>
   </configuration>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 自動作成および削除のための address-setting を設定します。以下の例では、前述の表に記載されているすべての設定要素を使用しています。

   <configuration ...>
    <core ...>
     ...
     <address-settings>
       <address-setting match="activemq.#">
         <auto-create-addresses>true</auto-create-addresses>
         <auto-delete-addresses>true</auto-delete-addresses>
         <auto-create-queues>true</auto-create-queues>
         <auto-delete-queues>true</auto-delete-queues>
         <default-address-routing-type>ANYCAST</default-address-routing-type>
       </address-setting>
     </address-settings>
     ...
    </core>
   </configuration>

   address-setting

   address-setting 要素の設定は、ワイルドカードアドレス activemq.# にマッチするすべてのアドレスまたはキューに適用されます。

   auto-create-addresses

   クライアントが存在しないアドレスへの接続を要求すると、ブローカーはアドレスを作成します。

   auto-delete-addresses

   自動作成されたアドレスは、キューに関連付けられなくなった時点で削除されます。

   auto-create-queues

   クライアントが存在しないキューへの接続を要求すると、ブローカーはキューを作成します。

   auto-delete-queues

   自動作成されたキューは、コンシューマーまたはメッセージがないと削除されます。

   default-address-routing-type

   クライアントが接続時にルーティングタイプを指定しない場合、ブローカーはアドレスにメッセージを配信する際に ANYCAST を使用します。デフォルト値は MULTICAST です。

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 指定のキューに、last-value-key キーを追加し、カスタム値を指定します。以下に例を示します。

   <address name="my.address">
       <multicast>
           <queue name="prices1" last-value-key="stock_ticker"/>
       </multicast>
   </address>

3. また、デフォルトのラストバリューキー名 _AMQ_LVQ_NAME を使用するラストバリューキューを設定することもできます。これを行うには、与えられたキューに last-value のキーを追加します。この値は true に設定します。以下に例を示します。

   <address name="my.address">
       <multicast>
           <queue name="prices1" last-value="true"/>
       </multicast>
   </address>

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. address-setting 要素に一致するアドレスの場合は、default-last-value-key を追加します。カスタム値を指定します。以下に例を示します。

   <address-setting match="lastValue">
      <default-last-value-key>stock_ticker</default-last-value-key>
   </address-setting>

   上記の設定に基づいて、lastValue アドレスに関連付けられたすべてのキューは、stock_ticker の最後の値キーを使用します。デフォルトでは、default -last-value-key の値は設定されていません。

3. 一連のアドレスに対してラストバリューキューを設定するには、アドレスのワイルドカードを指定することができます。以下に例を示します。

   <address-setting match="lastValue.*">
      <default-last-value-key>stock_ticker</default-last-value-key>
   </address-setting>

4. または、アドレスに関連付けられたすべてのキューや一連のアドレスを設定して、デフォルトの最後の値キー名である _AMQ_LVQ_NAME を使用することができます。これを行うには、default-last-value-key の代わりに default-last-value-queue を追加します。この値は true に設定します。以下に例を示します。

   <address-setting match="lastValue">
      <default-last-value-queue>true</default-last-value-queue>
   </address-setting>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. キューを最後の値キューとして個別に設定している場合は、non-destructive キーを追加します。この値は true に設定します。以下に例を示します。

   <address name="my.address">
      <multicast>
         <queue name="orders1" last-value-key="stock_ticker" non-destructive="true" />
      </multicast>
   </address>

3. 以前、最後の値キューにアドレスまたは一連のアドレス を設定している場合は、default-non-destructive キーを追加します。この値は true に設定します。以下に例を示します。

   <address-setting match="lastValue">
      <default-last-value-key>stock_ticker </default-last-value-key>
      <default-non-destructive>true</default-non-destructive>
   </address-setting>

   注記

   デフォルトでは、default-non-destructive の値は false です。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. core 要素で、message-expiry-scan-period を設定して、ブローカーが期限切れのメッセージをスキャンする頻度を指定します。

   <configuration ...>
      <core ...>
         ...
         <message-expiry-scan-period>1000</message-expiry-scan-period>
         ...

   前述の設定に基づいて、ブローカーは 1000 ミリ秒ごとに期限切れのメッセージのキューをスキャンします。

3. 一致するアドレスまたは一連のアドレスの address-setting 要素で、有効期限切れのアドレスを指定します。また、メッセージの有効期限を設定します。以下に例を示します。

   <configuration ...>
      <core ...>
         ...
         <address-settings>
            ...
            <address-setting match="stocks">
               ...
               <expiry-address>ExpiryAddress</expiry-address>
               <expiry-delay>10</expiry-delay>
               ...
            </address-setting>
            ...
         <address-settings>
   <configuration ...>

   expiry-address

   一致するアドレスや一連のアドレスの有効期限。前述の例では、ブローカーは stocks アドレスに対する期限切れメッセージを ExpiryAddress と呼ばれる期限切れアドレスに送信します。

   expiry-delay

   デフォルトの有効期限を使用するメッセージにブローカーが適用される有効期限 (ミリ秒単位)。デフォルトでは、メッセージの有効期限は 0 で、有効期限がないことを意味します。デフォルト以上の有効期限が設定されているメッセージに対しては、expiry-delay は効果がありません。

   例えば、先ほどの例のように、アドレスの expiry-delay を 10 に設定したとします。デフォルトの有効期限が 0 のメッセージがこのアドレスのキューに到着した場合、ブローカーはメッセージの有効期限を 0 から 10 に変更します。しかし、有効期限を 20 に設定している別のメッセージが到着した場合、その有効期限は変更されません。expiry-delay を -1 に設定した場合、この機能は無効になります。デフォルトでは、expiry-delay は -1 に設定されます。

4. また、expiry-delay に値を指定する代わりに、expiry delay の最小値と最大値を指定することもできます。以下に例を示します。

   <configuration ...>
      <core ...>
         ...
         <address-settings>
            ...
            <address-setting match="stocks">
               ...
               <expiry-address>ExpiryAddress</expiry-address>
               <min-expiry-delay>10</min-expiry-delay>
               <max-expiry-delay>100</max-expiry-delay>
               ...
            </address-setting>
            ...
         <address-settings>
   <configuration ...>

   min-expiry-delay

   ブローカーがメッセージに適用される最小有効期限 (ミリ秒単位)。

   max-expiry-delay

   ブローカーがメッセージに適用される最大有効期限 (ミリ秒単位)。

   ブローカーは、以下のように min-expiry-delay と max-expiry-delay の値を適用します。

   • デフォルトの有効期限が 0 のメッセージに対して、ブローカーは有効期限を指定された値の max-expiry-delay に設定します。max-expiry-delay の値を指定していない場合、ブローカーは指定された min-expiry-delay の値に満了時間を設定します。min-expiry-delay の値を指定しない場合、ブローカーはメッセージの有効期限を変更しません。
   • max-expiry-delay の値を上回る有効期限のあるメッセージの場合、ブローカーは有効期限を max-expiry-delay の指定値に設定します。
   • 有効期限が min-expiry-delay の値以下のメッセージに対して、ブローカーは有効期限を指定された min-expiry-delay の値に設定します。
   • min-expiry-delay および max-expiry-delay の値の間に有効期限のあるメッセージの場合、ブローカーはメッセージの有効期限を変更しません。
   • expiry-delay の値 (すなわちデフォルト値の -1 以外) を指定すると、min-expiry-delay および max-expiry-delay に指定する値が上書きされます。
   • min-expiry-delay と max-expiry-delay の両方のデフォルト値は -1 (つまり無効) です。

5. 設定ファイルの address 要素で、以前に expiry-address に指定したアドレスを設定します。このアドレスにキューを定義します。以下に例を示します。

   <addresses>
       ...
       <address name="ExpiryAddress">
           <anycast>
               <queue name="ExpiryQueue"/>
           </anycast>
       </address>
       ...
   </addresses>

   前述の設定例では、期限切れキュー ExpiryQueue と期限切れアドレス ExpiryAddress を関連付けています。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 以前、設定ファイルに追加した <address-setting> 要素を探して、一致するアドレスまたは一連のアドレスの有効期限を定義します。以下に例を示します。

   <configuration ...>
   
      <core ...>
         ...
         <address-settings>
            ...
            <address-setting match="stocks">
               ...
               <expiry-address>ExpiryAddress</expiry-address>
               ...
            </address-setting>
            ...
         <address-settings>
   <configuration ...>

3. <address-setting> 要素に、期限切れリソース (すなわちアドレスやキュー) を自動的に作成することや、これらのリソースにどのような名前を付けるかをブローカに指示する設定項目を追加します。以下に例を示します。

   <configuration ...>
      <core ...>
         ...
         <address-settings>
            ...
            <address-setting match="stocks">
               ...
               <expiry-address>ExpiryAddress</expiry-address>
               <auto-create-expiry-resources>true</auto-create-expiry-resources>
               <expiry-queue-prefix>EXP.</expiry-queue-prefix>
               <expiry-queue-suffix></expiry-queue-suffix>
               ...
            </address-setting>
            ...
         <address-settings>
   <configuration ...>

   auto-create-expiry-resources

   期限切れのメッセージを受信するため、ブローカーが期限切れアドレスとキューを自動的に作成するかどうかを指定します。デフォルト値は false です。

   パラメーターの値が true に設定されている場合、ブローカーは期限切れアドレスと関連付けられた期限切れキューを定義する <address> 要素を自動的に作成します。自動的に作成された <address> 要素の名前の値は、<expiry-address> に指定された名前の値と一致します。

   自動作成された期限切れキューには、multicast ルーティングタイプがあります。デフォルトでは、ブローカは失効したメッセージが最初に送信されたアドレス (例えば、stocks) と一致するように失効キューに名前を付けています。

   ブローカーは、_AMQ_ORIG_ADDRESS プロパティーを使用する期限切れキューのフィルターも定義します。このフィルターは、期限切れキューが対応する元のアドレスに送信されるメッセージのみを受け取るようになります。

   expiry-queue-prefix

   ブローカーにより、自動作成された期限切れキューの名前に適用される接頭辞。デフォルト値は EXP です。

   接頭辞の値を定義した場合、またはデフォルト値を維持した場合、期限切れキューの名前は、接頭辞と元のアドレスを連結したものになります (例: EXP.stocks)。

   expiry-queue-suffix

   ブローカーが自動作成された期限切れキューの名前に適用される接尾辞。デフォルト値は定義されていません (つまり、ブローカーは接尾辞を適用しません)。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. キュー名と一致する <address-setting> 要素で、デッドレターのアドレス名と配信試行回数の最大値を設定します。以下に例を示します。

   <configuration ...>
      <core ...>
         ...
         <address-settings>
            ...
            <address-setting match="exampleQueue">
               <dead-letter-address>DLA</dead-letter-address>
               <max-delivery-attempts>3</max-delivery-attempts>
            </address-setting>
         ...
         <address-settings>
   <configuration ...>

   match

   ブローカーがこの address-setting セクションの設定を適用するアドレス。<address-setting> 要素の match 属性には、ワイルドカード式を指定できます。ワイルドカード式を使用すると、<address-setting> 要素に設定されたデッドレター設定を一致する一連のアドレスに関連付ける場合に便利です。

   dead-letter-address

   デッドレターアドレスの名前。この例では、ブローカーは未配信メッセージをキュー exampleQueue から dead letter address(DLA) に移動します。

   max-delivery-attempts

   未配信メッセージを設定済みのデッドレターアドレスに移動するまでの、ブローカーによる配信試行の最大数。この例では、ブローカーは配信に失敗した 3 回失敗した後、未配信メッセージを dead letter address に移動します。デフォルト値は 10 です。ブローカーが再配信の試行を無限にするには、-1 の値を指定します。

3. addresses セクションに、デッドレターアドレス (DLA) の address 要素を追加します。デッドレターキューをデッドレターアドレスに関連付けるには、queue の名前を指定します。以下に例を示します。

   <configuration ...>
      <core ...>
         ...
         <addresses>
            <address name="DLA">
               <anycast>
                  <queue name="DLQ" />
               </anycast>
            </address>
         ...
         </addresses>
      </core>
   </configuration>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 一致したキューまたはキューのセットのデッドレターアドレスを定義するために追加した <address-setting> 要素を見つけます。以下に例を示します。

   <configuration ...>
      <core ...>
         ...
         <address-settings>
            ...
            <address-setting match="exampleQueue">
               <dead-letter-address>DLA</dead-letter-address>
               <max-delivery-attempts>3</max-delivery-attempts>
            </address-setting>
         ...
         <address-settings>
   <configuration ...>

3. <address-setting> 要素に、ブローカーに対してデッドレターリソース (アドレスおよびキュー) を自動的に作成し、これらのリソースに名前を付ける設定項目を追加します。以下に例を示します。

   <configuration ...>
      <core ...>
         ...
         <address-settings>
            ...
            <address-setting match="exampleQueue">
               <dead-letter-address>DLA</dead-letter-address>
               <max-delivery-attempts>3</max-delivery-attempts>
               <auto-create-dead-letter-resources>true</auto-create-dead-letter-resources>
               <dead-letter-queue-prefix>DLQ.</dead-letter-queue-prefix>
               <dead-letter-queue-suffix></dead-letter-queue-suffix>
            </address-setting>
         ...
         <address-settings>
   <configuration ...>

   auto-create-dead-letter-resources

   ブローカーがデッドレターアドレスおよびキューを自動的に作成し、未配信メッセージを受信するかどうかを指定します。デフォルト値は false です。

   auto-create-dead-letter-resources が true に設定されている場合、ブローカーはデッドレターアドレスと関連するデッドレターキューを定義する <address> 要素を自動的に作成します。自動作成された <address> 要素の名前は、<dead-letter-address> に指定する name の値と一致します。

   ブローカーが自動作成された <address> 要素で定義するデッドレターキューには、multicast ルーティングタイプがあります。デフォルトでは、ブローカーがデッドレターキューに名前を付け、未達のメッセージの元のアドレス (stocks など) を照合します。

   ブローカーは、_AMQ_ORIG_ADDRESS プロパティーを使用するデッドレターキューのフィルターも定義します。このフィルターは、デッドレターキューが対応する元のアドレスに送信されるメッセージのみを受け取るようになります。

   dead-letter-queue-prefix

   ブローカーにより、自動作成されたデッドレターキューの名前に適用される接頭辞。デフォルト値は DLQ です。

   接頭辞値を定義するか、デフォルト値を維持する場合、デッドレターキューの名前は接頭辞と元のアドレス (DLQ.stocks など) の連結になります。

   dead-letter-queue-suffix

   ブローカーにより、自動作成されたデッドレターキューに適用される接尾辞。デフォルト値は定義されていません (つまり、ブローカーは接尾辞を適用しません)。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 指定されたキューに、exclusive キーを追加します。この値は true に設定します。

   <configuration ...>
     <core ...>
       ...
       <address name="my.address">
         <multicast>
           <queue name="orders1" exclusive="true"/>
         </multicast>
       </address>
     </core>
   </configuration>

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 一致するアドレスの address-setting 要素に default-exclusive-queue キーを追加します。この値は true に設定します。

   <address-setting match="myAddress">
       <default-exclusive-queue>true</default-exclusive-queue>
   </address-setting>

   上記の設定に基づいて、myAddress に関連付けられたすべてのキューは排他的です。デフォルトでは、default-exclusive-queue の値は false です。

3. アドレスセットに排他的キューを設定するには、アドレスワイルドカードを指定します。以下に例を示します。

   <address-setting match="myAddress.*">
       <default-exclusive-queue>true</default-exclusive-queue>
   </address-setting>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 明示的なリングサイズが設定されていない一致するアドレスですべてのキューのデフォルトリングサイズを定義するには、address- setting 要素に default-ring-size の値を指定します。以下に例を示します。

   <address-settings>
      <address-setting match="ring.#">
         <default-ring-size>3</default-ring-size>
      </address-setting>
   </address-settings>

   default-ring-size パラメーターは、自動作成されるキューのデフォルトサイズを定義する場合に特に便利です。default-ring-size のデフォルト値は -1(サイズ制限なし) です。

3. 特定のキューにリングサイズを定義するには、queue 要素に ring-size キーを追加します。値を指定します。以下に例を示します。

   <addresses>
      <address name="myRing">
         <anycast>
            <queue name="myRing" ring-size="5" />
         </anycast>
      </address>
   </addresses>

1. プロデューサーは、ring-size="3" で設定したリングキューに 3 つのメッセージを送信します。

2. すべてのメッセージは即座にコンシューマーにディスパッチされます。

   この時点で、messageCount= 3 および deliveryCount= 3 です。

3. プロデューサーは別のメッセージをキューに送信します。その後、メッセージはコンシューマーにディスパッチされます。

   現在、messageCount = 4 および deliveryCount = 4 です。4 のメッセージ数は、設定されたリングサイズ 3 を超えています。ただし、ブローカーはキューから再配信メッセージを削除できません。

4. 現在は、メッセージを承認せずにコンシューマーが閉じられているとします。

   この場合、4 つのインポイントで承認されていないメッセージはブローカーにキャンセルされ、消費元の逆順でキューの先頭に追加されます。このアクションにより、設定されたリングサイズにキューが追加されます。リングキューはヘッドでメッセージの末尾にあるメッセージを優先するため、キューは最後のメッセージがキューの先頭に追加されていたため、プロデューサーによって送信された最初のメッセージを破棄します。トランザクションまたはコアセッションのロールバックは同じように処理されます。

1. 12:00 では、プロデューサーはメッセージ A を ring-size="3" で設定されたリングキューに送信します。メッセージは 12:05 に対してスケジュールされます。

   この時点で、messageCount= 1 および scheduledCount= 1 になります。

2. 12:01 では、プロデューサーはメッセージ B を同じリングキューに送信します。

   現在、messageCount= 2 および scheduledCount= 1。

3. 12:02 では、プロデューサーはメッセージ C を同じリングキューに送信します。

   現在、messageCount= 3 および scheduledCount= 1。

4. 12:03 時、プロデューサーはメッセージ D を同じリングキューに送信します。

   現在、messageCount= 4 および scheduledCount= 1。

   キューのメッセージ数は 4 で、設定されたリングサイズから 3 よりも大きい ようになりました。ただし、スケジュールされたメッセージはキューでは技術的ではありません (つまり、ブローカーにあり、キューに配置するようにスケジュールされています)。スケジュールされた配信時間 12:05 にすると、ブローカーはメッセージをキューのヘッドに配置します。ただし、リングキューが設定サイズをすでに到達しているため、スケジュールされたメッセージ A はすぐに削除されます。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. <federation> 要素が含まれる新しい <federations > 要素を追加します。以下に例を示します。

   <federations>
     <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
     </federation>
   </federations>

   name

   フェデレーション設定の名前。この例では、名前はローカルブローカーの名前に対応します。

   user

   アップストリームブローカーに接続するための共有ユーザー名。

   password

   アップストリームブローカーに接続するための共有パスワード。

   注記

   ユーザーとパスワードの認証情報がリモートブローカーごとに異なる場合は、設定に追加する時にこれらのブローカーの認証情報を個別に指定できます。これは、この手順の後半で説明します。

3. federation 要素内に <address-policy> 要素を追加します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <address-policy name="news-address-federation" auto-delete="true" auto-delete-delay="300000" auto-delete-message-count="-1" enable-divert-bindings="false" max-hops="1" transformer-ref="news-transformer">
           </address-policy>
   
       </federation>
   </federations>

   name

   アドレスポリシーの名前。ブローカーに設定されるアドレスポリシーはすべて一意の名前を指定する必要があります。

   auto-delete

   アドレスのフェデレーション時に、ローカルブローカーはリモートアドレスに永続キューを動的に作成します。auto-delete プロパティーの値は、ローカルブローカーの切断後にリモートキューを削除するかどうかを指定します。また、auto-delete-delay および auto- delete-message-count プロパティーの値も到達するかどうかを指定します。動的に作成されたキューのクリーンアップを自動化する場合に便利なオプションです。また、ローカルブローカーが長時間切断されている場合に、リモートブローカーでメッセージをビルドできないようにする場合にも便利なオプションです。ただし、接続されていない間にメッセージをローカルブローカーに対して常にキューに入れる必要がある場合、このオプションを false に設定します。これにより、ローカルブローカーでメッセージが失われないようにします。

   auto-delete-delay

   ローカルブローカーが切断されると、このプロパティーの値は、動的に作成されるリモートキューが自動的に削除されるまでの時間 (ミリ秒単位) を指定します。

   auto-delete-message-count

   ローカルブローカーが切断されると、このプロパティーの値は、キューが自動的に削除される前に動的に作成されたリモートキューにあるメッセージの最大数を指定します。

   enable-divert-bindings

   このプロパティーを true に設定すると、迂回バインディングは必要に応じてリッスンできます。アドレスポリシーに含まれるアドレスに一致するアドレスを持つ迂回バインディングがある場合、迂回の転送アドレスに一致するキューバインディングは要求を作成します。デフォルト値は false です。

   max-hops

   フェデレーション中にメッセージが実行できるホップの最大数。特定のトポロジーでは、このプロパティーに特定の値が必要です。これらの要件の詳細は、「アドレスフェデレーションの一般的なトポロジー」 を参照してください。

   transformer-ref

   トランスフォーマー設定の名前。フェデレーションされたメッセージ送信時にメッセージを変換したい場合は、トランスフォーマー設定を追加することができます。トランスフォーマー設定は、この手順の後半で説明します。

4. <address-policy> 要素内に、アドレスポリシーからアドレスを追加し、アドレスを除外するためのアドレス一致パターンを追加します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <address-policy name="news-address-federation" auto-delete="true" auto-delete-delay="300000" auto-delete-message-count="-1" enable-divert-bindings="false" max-hops="1" transformer-ref="news-transformer">
   
               <include address-match="queue.bbc.new" />
               <include address-match="queue.usatoday" />
               <include address-match="queue.news.#" />
   
               <exclude address-match="queue.news.sport.#" />
           </address-policy>
   
       </federation>
   </federations>

   include

   この要素の address-match プロパティーの値は、アドレスポリシーに含めるアドレスを指定します。queue.bbc.new や queue.usatoday など、正確なアドレスを指定できます。または、ワイルドカード式を使用して一致するアドレスの セット を指定できます。上記の例では、アドレスポリシーには文字列 queue.news で始まるすべての アドレス名も含まれています。

   exclude

   この要素の address-match プロパティーの値は、アドレスポリシーから除外するアドレスを指定します。正確なアドレス名を指定するか、ワイルドカード式を使用して一致するアドレスの セット を指定できます。上記の例では、アドレスポリシーは文字列 queue.news.sport で始まるすべてのアドレス名を除外します。

5. (任意)federation 要素 では、transformer 要素を追加してカスタムトランスフォーマー実装を参照します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <address-policy name="news-address-federation" auto-delete="true" auto-delete-delay="300000" auto-delete-message-count="-1" enable-divert-bindings="false" max-hops="1" transformer-ref="news-transformer">
   
               <include address-match="queue.bbc.new" />
               <include address-match="queue.usatoday" />
               <include address-match="queue.news.#" />
   
               <exclude address-match="queue.news.sport.#" />
           </address-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
   </federations>

   name

   トランスフォーマー設定の名前。この名前は、ローカルブローカーで一意である必要があります。これは、アドレスポリシーの transformer-ref プロパティーの値として指定する名前です。

   class-name

   org.apache.activemq.artemis.core.server.transformer.Transformer インターフェイスを実装するユーザー定義クラスの名前。

   トランスフォーマーの transform() メソッドは、メッセージが送信される前にメッセージで呼び出されます。これにより、メッセージヘッダーまたはボディーをフェデレーションする前に変換できます。

   プロパティー

   特定のトランスフォーマー設定のキーと値のペアを保持するために使用されます。

6. federation 要素内に、upstream 要素を 1 つ以上追加します。各 upstream 要素は、リモートブローカーへの接続と、その接続に適用するポリシーを定義します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <upstream name="eu-east-1">
               <static-connectors>
                   <connector-ref>eu-east-connector1</connector-ref>
               </static-connectors>
               <policy ref="news-address-federation"/>
           </upstream>
   
           <upstream name="eu-west-1" >
               <static-connectors>
                   <connector-ref>eu-west-connector1</connector-ref>
               </static-connectors>
               <policy ref="news-address-federation"/>
           </upstream>
   
           <address-policy name="news-address-federation" auto-delete="true" auto-delete-delay="300000" auto-delete-message-count="-1" enable-divert-bindings="false" max-hops="1" transformer-ref="news-transformer">
   
               <include address-match="queue.bbc.new" />
               <include address-match="queue.usatoday" />
               <include address-match="queue.news.#" />
   
               <exclude address-match="queue.news.sport.#" />
           </address-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
   </federations>

   static-connectors

   ローカルブローカーの broker.xml 設定ファイルの他の場所で定義される connector 要素を参照する connector-ref 要素の一覧が含まれます。コネクターは、送信接続に使用するトランスポート (TCP、SSL、HTTP など) およびサーバー接続パラメーター (ホスト、ポートなど) を定義します。この手順の次のステップは、static-connectors 要素で参照されるコネクターを追加する方法を示しています。

   policy-ref

   アップストリームブローカーに適用されるダウンストリームブローカーに設定されたアドレスポリシーの名前。

   アップストリーム 要素に指定できる追加オプションを以下に示します。

   name

   アップストリームブローカー設定の名前。この例では、名前は eu-east-1 と eu-west-1 というアップストリームブローカーに対応します。

   user

   アップストリームブローカーへの接続の作成時に使用するユーザー名。指定のない場合は、federation 要素の設定に指定された共有ユーザー名が使用されます。

   password

   アップストリームブローカーへの接続の作成時に使用するパスワード。指定のない場合は、federation 要素の設定に指定された共有パスワードが使用されます。

   call-failover-timeout

   call-timeout と同様ですが、フェイルオーバーの試行中に呼び出しが行われる場合に使用されます。デフォルト値は -1 で、タイムアウトが無効であることを意味します。

   call-timeout

   ブロック呼び出しであるパケットを送信すると、フェデレーション接続がリモートブローカーからの応答を待つ時間 (ミリ秒単位)。この時間が経過すると、接続によって例外が発生します。デフォルト値は 30000 です。

   check-period

   フェデレーション接続の健常性を確認するために、ローカルブローカがリモートブローカに送信する連続した“keep-alive"メッセージ間の期間 (ミリ秒)。フェデレーション接続が正常である場合、リモートブローカーは各キープアライブメッセージに応答します。接続が正常でないと、ダウンストリームブローカーがアップストリームブローカーから応答を受信できない場合に、サーキットブレーカー と呼ばれるメカニズムを使用してフェデレーションされたコンシューマーをブロックします。詳細は、circuit-breaker-timeout パラメーターの説明を参照してください。check-period パラメーターのデフォルト値は 30000 です。

   circuit-breaker-timeout

   ダウンストリームとアップストリームブローカー間の単一の接続は、多くのフェデレーションされたキューとアドレスコンシューマーによって共有される可能性があります。ブローカー間の接続が失われた場合、フェデレーションされた各コンシューマーは同時に再接続を試みる可能性があります。これを回避するには、サーキットブレーカー と呼ばれるメカニズムはコンシューマーをブロックします。指定したタイムアウト値が経過すると、サーキットブレーカーは接続を再送します。成功すると、コンシューマーはブロックされません。それ以外の場合は、サーキットブレーカーが再度適用されます。

   connection-ttl

   リモートブローカーからのメッセージを受信しなくなった場合に、フェデレーション接続が存続する時間 (ミリ秒単位)。デフォルト値は 60000 です。

   discovery-group-ref

   アップストリームブローカーへの接続に静的コネクターを定義する代わりに、この要素を使用して broker.xml 設定ファイルの別の場所で設定済みの検出グループを指定できます。具体的には、この要素の discovery-group-name プロパティーの値として、既存の検出グループを指定します。検出グループの詳細は、「ブローカー検出メソッド」 を参照してください。

   ha

   アップストリームブローカーへの接続に対して、高可用性が有効であるかどうかを指定します。このパラメーターの値を true に設定すると、ローカルブローカーはアップストリームクラスターで利用可能なブローカーに接続でき、ライブアップストリームブローカーがシャットダウンすると、バックアップブローカーに自動フェイルオーバーされます。デフォルト値は false です。

   initial-connect-attempts

   ダウンストリームブローカーがアップストリームブローカーに接続するようにする初期試行の数。接続を確立せずにこの値に達すると、アップストリームブローカーは永続的にオフラインとみなされます。ダウンストリームブローカーは、メッセージをアップストリームブローカーにルーティングしなくなりました。デフォルト値は -1 で、制限なしを意味します。

   max-retry-interval

   リモートブローカーへの接続に失敗した場合に後続の再接続試行の間隔 (ミリ秒単位)。デフォルト値は 2000 です。

   reconnect-attempts

   接続が失敗した場合に、ダウンストリームブローカーがアップストリームブローカーへの再接続を試行する回数。接続が再確立されていない状態でこの値に達すると、アップストリームブローカーは永続的にオフラインとみなされます。ダウンストリームブローカーは、メッセージをアップストリームブローカーにルーティングしなくなりました。デフォルト値は -1 で、制限なしを意味します。

   retry-interval

   リモートブローカーへの接続に失敗した場合に、後続の再接続試行の間隔 (ミリ秒単位)。デフォルト値は 500 です。

   retry-interval-multiplier

   retry-interval パラメーターの値に適用される乗率。デフォルト値は 1 です。

   share-connection

   同じブローカーにダウンストリーム接続とアップストリーム接続の両方が設定されている場合には、ダウンストリーム設定とアップストリーム設定の両方がこのパラメーターの値を true に設定している限り、同じ接続が共有されます。デフォルト値は false です。

7. ローカルブローカーで、コネクターをリモートブローカーに追加します。これらは、フェデレーションされたアドレス設定の static-connectors 要素で参照されるコネクターです。以下に例を示します。

   <connectors>
      <connector name="eu-west-1-connector">tcp://localhost:61616</connector>
      <connector name="eu-east-1-connector">tcp://localhost:61617</connector>
   </connectors>

手順

1. ローカルブローカーで、<broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. <federation> 要素が含まれる <federations > 要素を追加します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
       </federation>
   </federations>

3. アドレスポリシー設定を追加します。以下に例を示します。

   <federations>
       ...
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <address-policy name="news-address-federation" max-hops="1" auto-delete="true" auto-delete-delay="300000" auto-delete-message-count="-1" transformer-ref="news-transformer">
   
               <include address-match="queue.bbc.new" />
               <include address-match="queue.usatoday" />
               <include address-match="queue.news.#" />
   
               <exclude address-match="queue.news.sport.#" />
           </address-policy>
   
       </federation>
     ...
   </federations>

4. 送信前にメッセージを変換する場合は、トランスフォーマー設定を追加します。以下に例を示します。

   <federations>
       ...
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <address-policy name="news-address-federation" max-hops="1" auto-delete="true" auto-delete-delay="300000" auto-delete-message-count="-1" transformer-ref="news-transformer">
   
               <include address-match="queue.bbc.new" />
               <include address-match="queue.usatoday" />
               <include address-match="queue.news.#" />
   
               <exclude address-match="queue.news.sport.#" />
           </address-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
     ...
   </federations>

5. 各リモートブローカーに ダウンストリーム 要素を追加します。以下に例を示します。

   <federations>
       ...
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <downstream name="eu-east-1">
                   <static-connectors>
                       <connector-ref>eu-east-connector1</connector-ref>
                   </static-connectors>
                   <transport-connector-ref>netty-connector</transport-connector-ref>
                   <policy ref="news-address-federation"/>
           </downstream>
   
           <downstream name="eu-west-1" >
                   <static-connectors>
                       <connector-ref>eu-west-connector1</connector-ref>
                   </static-connectors>
                   <transport-connector-ref>netty-connector</transport-connector-ref>
                   <policy ref="news-address-federation"/>
           </downstream>
   
           <address-policy name="news-address-federation" max-hops="1" auto-delete="true" auto-delete-delay="300000" auto-delete-message-count="-1" transformer-ref="news-transformer">
               <include address-match="queue.bbc.new" />
               <include address-match="queue.usatoday" />
               <include address-match="queue.news.#" />
   
               <exclude address-match="queue.news.sport.#" />
           </address-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
     ...
   </federations>

   上記の設定で示されているように、リモートブローカーはローカルブローカーのダウンストリームであると見なされます。ダウンストリームブローカーは、設定の接続情報を使用して、ローカル (アップストリーム) ブローカーへ再度接続します。

6. ローカルブローカーで、ローカルブローカーおよびリモートブローカーによって使用されるコネクターとアクセプターを追加して、フェデレーション接続を確立します。以下に例を示します。

   <connectors>
      <connector name="netty-connector">tcp://localhost:61616</connector>
      <connector name="eu-west-1-connector">tcp://localhost:61616</connector>
      <connector name="eu-east-1-connector">tcp://localhost:61617</connector>
   </connectors>
   
   <acceptors>
      <acceptor name="netty-acceptor">tcp://localhost:61616</acceptor>
   </acceptors>

   connector name="netty-connector"

   ローカルブローカーがリモートブローカーに送信するコネクター設定。リモートブローカーはこの設定を使用してローカルブローカーに接続し直します。

   connector name="eu-west-1-connector", connector name="eu-east-1-connector"

   リモートブローカーへのコネクター。ローカルブローカーはこれらのコネクターを使用してリモートブローカーに接続し、リモートブローカーがローカルブローカーに接続するために必要な設定を共有します。

   acceptor name="netty-acceptor"

   ローカルブローカーに接続するためにリモートブローカーによって使用されるコネクターに対応するローカルブローカーのアクセプター。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 新しい <federations> 要素に、<federation> 要素を追加します。以下に例を示します。

   <federations>
     <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
     </federation>
   </federations>

   name

   フェデレーション設定の名前。この例では、名前はダウンストリームブローカーの名前に対応します。

   user

   アップストリームブローカーに接続するための共有ユーザー名。

   password

   アップストリームブローカーに接続するための共有パスワード。

   注記
   • ユーザーとパスワードの認証情報がアップストリームブローカーごとに異なる場合は、設定に追加する時にこれらのブローカーの認証情報を個別に指定できます。これは、この手順の後半で説明します。

3. federation 要素内に <queue-policy> 要素を追加します。<queue-policy> 要素のプロパティー値を指定します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <queue-policy name="news-queue-federation" include-federated="true" priority-adjustment="-5" transformer-ref="news-transformer">
           </queue-policy>
   
       </federation>
   </federations>

   name

   キューポリシーの名前。ブローカーに設定されるキューポリシーはすべて一意の名前である必要があります。

   include-federated

   このプロパティーの値を false に設定すると、設定は、すでにフェデレーションされたコンシューマー (つまりフェデレーションされたキューのコンシューマー) は統合しなおされません。これにより、対称または閉ループトポロジーで、フェデレーションされていないコンシューマーが存在せず、メッセージがシステム内を無限に流れる状況を回避できます。

   閉ループトポロジーが ない 場合は、このプロパティーの値を true に設定できます。たとえば、3 つのブローカー、BrokerA、BrokerB、および BrokerC のチェーンがあり、プロデューサーが BrokerA のコンシューマーと BrokerC のコンシューマーがあるとします。この場合、BrokerB が コンシューマーを BrokerA にフェデレーションしなおす必要があります。

   priority-adjustment

   コンシューマーがキューに接続すると、その優先度は、アップストリーム (フェデレーションされた) コンシューマーの作成時に優先順位が使用されます。フェデレーションされたコンシューマーの優先度は、priority-adjustment プロパティーの値で調整します。このプロパティーのデフォルト値は -1 です。これにより、負荷分散時にローカルコンシューマーがフェデレーションされたコンシューマーよりも優先されます。ただし、必要に応じて優先順位の調整の値を変更できます。

   transformer-ref

   トランスフォーマー設定の名前。フェデレーションされたメッセージ送信時にメッセージを変換したい場合は、トランスフォーマー設定を追加することができます。トランスフォーマー設定は、この手順の後半で説明します。

4. <queue-policy> 要素内に、キューポリシーからアドレスを追加し、除外する address-matching パターンを追加します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <queue-policy name="news-queue-federation" include-federated="true" priority-adjustment="-5" transformer-ref="news-transformer">
   
               <include queue-match="#" address-match="queue.bbc.new" />
               <include queue-match="#" address-match="queue.usatoday" />
               <include queue-match="#" address-match="queue.news.#" />
   
               <exclude queue-match="#.local" address-match="#" />
   
           </queue-policy>
   
       </federation>
   </federations>

   include

   この要素の address-match プロパティーの値は、キューポリシーに含めるアドレスを指定します。queue.bbc.new や queue.usatoday など、正確なアドレスを指定できます。または、ワイルドカード式を使用して一致するアドレスの セット を指定できます。上記の例では、アドレスポリシーには文字列 queue.news で始まるすべてのアドレス名も含まれています。

   address-match プロパティーと組み合わせて、queue-match プロパティーを使用して、キューポリシーにこれらのアドレスに特定のキューを含めることができます。address-match プロパティーと同様に、正確なキュー名を指定するか、ワイルドカード式を使用して一連のキューを指定できます。上記の例では、番号記号 (#) のワイルドカード文字は、各アドレスまたはアドレスセットにある すべて のキューがキューポリシーに含まれることを示しています。

   exclude

   この要素の address-match プロパティーの値は、キューポリシーから除外するアドレスを指定します。正確なアドレスを指定するか、ワイルドカード式を使用して一致するアドレスの セット を指定できます。上記の例では、数字記号 (#) ワイルドカード文字は、全 アドレスの queue-match プロパティーと一致するキューがすべて除外されることを意味します。この場合、.local という文字列で終了するキューは除外されます。これは、特定のキューがローカルキューとして保持され、フェデレーションされていないことを示しています。

5. federation 要素 では、transformer 要素を追加してカスタムトランスフォーマー実装を参照します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <queue-policy name="news-queue-federation" include-federated="true" priority-adjustment="-5" transformer-ref="news-transformer">
   
               <include queue-match="#" address-match="queue.bbc.new" />
               <include queue-match="#" address-match="queue.usatoday" />
               <include queue-match="#" address-match="queue.news.#" />
   
               <exclude queue-match="#.local" address-match="#" />
   
           </queue-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
   </federations>

   name

   トランスフォーマー設定の名前。この名前は、対象となるブローカーで一意でなければなりません。この名前は、アドレスポリシーの transformer-ref プロパティーの値として指定します。

   class-name

   org.apache.activemq.artemis.core.server.transformer.Transformer インターフェイスを実装するユーザー定義クラスの名前。

   トランスフォーマーの transform() メソッドは、メッセージが送信される前にメッセージで呼び出されます。これにより、メッセージヘッダーまたはボディーをフェデレーションする前に変換できます。

   プロパティー

   特定のトランスフォーマー設定のキーと値のペアを保持するために使用されます。

6. federation 要素内に、upstream 要素を 1 つ以上追加します。各 upstream 要素は、アップストリームブローカー接続と、その接続に適用するポリシーを定義します。以下に例を示します。

   <federations>
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <upstream name="eu-east-1">
               <static-connectors>
                   <connector-ref>eu-east-connector1</connector-ref>
               </static-connectors>
               <policy ref="news-queue-federation"/>
           </upstream>
   
           <upstream name="eu-west-1" >
               <static-connectors>
                   <connector-ref>eu-west-connector1</connector-ref>
               </static-connectors>
               <policy ref="news-queue-federation"/>
           </upstream>
   
           <queue-policy name="news-queue-federation" include-federated="true" priority-adjustment="-5" transformer-ref="news-transformer">
   
               <include queue-match="#" address-match="queue.bbc.new" />
               <include queue-match="#" address-match="queue.usatoday" />
               <include queue-match="#" address-match="queue.news.#" />
   
               <exclude queue-match="#.local" address-match="#" />
   
           </queue-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
   </federations>

   static-connectors

   ローカルブローカーの broker.xml 設定ファイルの他の場所で定義される connector 要素を参照する connector-ref 要素の一覧が含まれます。コネクターは、送信接続に使用するトランスポート (TCP、SSL、HTTP など) およびサーバー接続パラメーター (ホスト、ポートなど) を定義します。以下の手順は、フェデレーションされたキュー設定の static-connectors 要素で参照されるコネクターを追加する方法を示しています。

   policy-ref

   アップストリームブローカーに適用されるダウンストリームブローカーに設定されたキューポリシーの名前。

   アップストリーム 要素に指定できる追加オプションを以下に示します。

   name

   アップストリームブローカー設定の名前。この例では、名前は eu-east-1 と eu-west-1 というアップストリームブローカーに対応します。

   user

   アップストリームブローカーへの接続の作成時に使用するユーザー名。指定のない場合は、federation 要素の設定に指定された共有ユーザー名が使用されます。

   password

   アップストリームブローカーへの接続の作成時に使用するパスワード。指定のない場合は、federation 要素の設定に指定された共有パスワードが使用されます。

   call-failover-timeout

   call-timeout と同様ですが、フェイルオーバーの試行中に呼び出しが行われる場合に使用されます。デフォルト値は -1 で、タイムアウトが無効であることを意味します。

   call-timeout

   ブロック呼び出しであるパケットを送信すると、フェデレーション接続がリモートブローカーからの応答を待つ時間 (ミリ秒単位)。この時間が経過すると、接続によって例外が発生します。デフォルト値は 30000 です。

   check-period

   フェデレーション接続の健常性を確認するために、ローカルブローカがリモートブローカに送信する連続した“keep-alive"メッセージ間の期間 (ミリ秒)。フェデレーション接続が正常である場合、リモートブローカーは各キープアライブメッセージに応答します。接続が正常でないと、ダウンストリームブローカーがアップストリームブローカーから応答を受信できない場合に、サーキットブレーカー と呼ばれるメカニズムを使用してフェデレーションされたコンシューマーをブロックします。詳細は、circuit-breaker-timeout パラメーターの説明を参照してください。check-period パラメーターのデフォルト値は 30000 です。

   circuit-breaker-timeout

   ダウンストリームとアップストリームブローカー間の単一の接続は、多くのフェデレーションされたキューとアドレスコンシューマーによって共有される可能性があります。ブローカー間の接続が失われた場合、フェデレーションされた各コンシューマーは同時に再接続を試みる可能性があります。これを回避するには、サーキットブレーカー と呼ばれるメカニズムはコンシューマーをブロックします。指定したタイムアウト値が経過すると、サーキットブレーカーは接続を再送します。成功すると、コンシューマーはブロックされません。それ以外の場合は、サーキットブレーカーが再度適用されます。

   connection-ttl

   リモートブローカーからのメッセージを受信しなくなった場合に、フェデレーション接続が存続する時間 (ミリ秒単位)。デフォルト値は 60000 です。

   discovery-group-ref

   アップストリームブローカーへの接続に静的コネクターを定義する代わりに、この要素を使用して broker.xml 設定ファイルの別の場所で設定済みの検出グループを指定できます。具体的には、この要素の discovery-group-name プロパティーの値として、既存の検出グループを指定します。検出グループの詳細は、「ブローカー検出メソッド」 を参照してください。

   ha

   アップストリームブローカーへの接続に対して、高可用性が有効であるかどうかを指定します。このパラメーターの値を true に設定すると、ローカルブローカーはアップストリームクラスターで利用可能なブローカーに接続でき、ライブアップストリームブローカーがシャットダウンすると、バックアップブローカーに自動フェイルオーバーされます。デフォルト値は false です。

   initial-connect-attempts

   ダウンストリームブローカーがアップストリームブローカーに接続するようにする初期試行の数。接続を確立せずにこの値に達すると、アップストリームブローカーは永続的にオフラインとみなされます。ダウンストリームブローカーは、メッセージをアップストリームブローカーにルーティングしなくなりました。デフォルト値は -1 で、制限なしを意味します。

   max-retry-interval

   リモートブローカーへの接続に失敗した場合に後続の再接続試行の間隔 (ミリ秒単位)。デフォルト値は 2000 です。

   reconnect-attempts

   接続が失敗した場合に、ダウンストリームブローカーがアップストリームブローカーへの再接続を試行する回数。接続が再確立されていない状態でこの値に達すると、アップストリームブローカーは永続的にオフラインとみなされます。ダウンストリームブローカーは、メッセージをアップストリームブローカーにルーティングしなくなりました。デフォルト値は -1 で、制限なしを意味します。

   retry-interval

   リモートブローカーへの接続に失敗した場合に、後続の再接続試行の間隔 (ミリ秒単位)。デフォルト値は 500 です。

   retry-interval-multiplier

   retry-interval パラメーターの値に適用される乗率。デフォルト値は 1 です。

   share-connection

   同じブローカーにダウンストリーム接続とアップストリーム接続の両方が設定されている場合には、ダウンストリーム設定とアップストリーム設定の両方がこのパラメーターの値を true に設定している限り、同じ接続が共有されます。デフォルト値は false です。

7. ローカルブローカーで、コネクターをリモートブローカーに追加します。これらは、フェデレーションされたアドレス設定の static-connectors 要素で参照されるコネクターです。以下に例を示します。

   <connectors>
      <connector name="eu-west-1-connector">tcp://localhost:61616</connector>
      <connector name="eu-east-1-connector">tcp://localhost:61617</connector>
   </connectors>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. <federation> 要素が含まれる <federations > 要素を追加します。以下に例を示します。

   <federations>
     <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
     </federation>
   </federations>

3. キューポリシー設定を追加します。以下に例を示します。

   <federations>
       ...
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <queue-policy name="news-queue-federation" priority-adjustment="-5" include-federated="true" transformer-ref="new-transformer">
   
               <include queue-match="#" address-match="queue.bbc.new" />
               <include queue-match="#" address-match="queue.usatoday" />
               <include queue-match="#" address-match="queue.news.#" />
   
               <exclude queue-match="#.local" address-match="#" />
   
           </queue-policy>
   
       </federation>
     ...
   </federations>

4. 送信前にメッセージを変換する場合は、トランスフォーマー設定を追加します。以下に例を示します。

   <federations>
       ...
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <queue-policy name="news-queue-federation" priority-adjustment="-5" include-federated="true" transformer-ref="news-transformer">
   
               <include queue-match="#" address-match="queue.bbc.new" />
               <include queue-match="#" address-match="queue.usatoday" />
               <include queue-match="#" address-match="queue.news.#" />
   
               <exclude queue-match="#.local" address-match="#" />
   
           </queue-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
     ...
   </federations>

5. 各リモートブローカーに ダウンストリーム 要素を追加します。以下に例を示します。

   <federations>
       ...
       <federation name="eu-north-1" user="federation_username" password="32a10275cf4ab4e9">
   
           <downstream name="eu-east-1">
               <static-connectors>
                   <connector-ref>eu-east-connector1</connector-ref>
               </static-connectors>
               <transport-connector-ref>netty-connector</transport-connector-ref>
               <policy ref="news-address-federation"/>
           </downstream>
   
           <downstream name="eu-west-1" >
               <static-connectors>
                   <connector-ref>eu-west-connector1</connector-ref>
               </static-connectors>
               <transport-connector-ref>netty-connector</transport-connector-ref>
               <policy ref="news-address-federation"/>
           </downstream>
   
           <queue-policy name="news-queue-federation" priority-adjustment="-5" include-federated="true" transformer-ref="new-transformer">
   
               <include queue-match="#" address-match="queue.bbc.new" />
               <include queue-match="#" address-match="queue.usatoday" />
               <include queue-match="#" address-match="queue.news.#" />
   
               <exclude queue-match="#.local" address-match="#" />
   
           </queue-policy>
   
           <transformer name="news-transformer">
               <class-name>org.foo.NewsTransformer</class-name>
               <property key="key1" value="value1"/>
               <property key="key2" value="value2"/>
           </transformer>
   
       </federation>
     ...
   </federations>

   上記の設定で示されているように、リモートブローカーはローカルブローカーのダウンストリームであると見なされます。ダウンストリームブローカーは、設定の接続情報を使用して、ローカル (アップストリーム) ブローカーへ再度接続します。

6. ローカルブローカーで、ローカルブローカーおよびリモートブローカーによって使用されるコネクターとアクセプターを追加して、フェデレーション接続を確立します。以下に例を示します。

   <connectors>
      <connector name="netty-connector">tcp://localhost:61616</connector>
      <connector name="eu-west-1-connector">tcp://localhost:61616</connector>
      <connector name="eu-east-1-connector">tcp://localhost:61617</connector>
   </connectors>
   
   <acceptors>
      <acceptor name="netty-acceptor">tcp://localhost:61616</acceptor>
   </acceptors>

   connector name="netty-connector"

   ローカルブローカーがリモートブローカーに送信するコネクター設定。リモートブローカーはこの設定を使用してローカルブローカーに接続し直します。

   connector name="eu-west-1-connector" , connector name="eu-east-1-connector"

   リモートブローカーへのコネクター。ローカルブローカーはこれらのコネクターを使用してリモートブローカーに接続し、リモートブローカーがローカルブローカーに接続するために必要な設定を共有します。

   acceptor name="netty-acceptor"

   ローカルブローカーに接続するためにリモートブローカーによって使用されるコネクターに対応するローカルブローカーのアクセプター。

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 特定のアクセプターでは、sslEnabled キーを追加し、値を true に設定します。さらに、keyStorePath キーおよび keyStorePassword キーを追加します。ブローカーキーストアに対応する値を設定します。以下に例を示します。

   <acceptor name="artemis">tcp://0.0.0.0:61616?sslEnabled=true;keyStorePath=../etc/broker.keystore;keyStorePassword=1234!</acceptor>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 一方向 TLS 用に以前に設定したアクセプターの場合は、needClientAuth キーを追加します。この値は true に設定します。以下に例を示します。

   <acceptor name="artemis">tcp://0.0.0.0:61616?sslEnabled=true;keyStorePath=../etc/broker.keystore;keyStorePassword=1234!;needClientAuth=true</acceptor>

3. 前述の手順の設定は、クライアントの証明書が信頼できるプロバイダーによって署名されていることを前提としています。クライアントの証明書が信頼されるプロバイダー (自己署名の場合など) で署名されて いない 場合には、ブローカーはクライアントの証明書をトラストストアにインポートする必要があります。この場合は、trustStorePath キーおよび trustStorePassword キーを追加します。ブローカーのトラストストアに対応する値を設定します。以下に例を示します。

   <acceptor name="artemis">tcp://0.0.0.0:61616?sslEnabled=true;keyStorePath=../etc/broker.keystore;keyStorePassword=1234!;needClientAuth=true;trustStorePath=../etc/client.truststore;trustStorePassword=5678!</acceptor>

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. security-settings 要素内に security-setting 要素を追加してパーミッションを設定します。以下に例を示します。

   <security-settings>
       <security-setting match="#">
           <permission type="createDurableQueue" roles="user"/>
           <permission type="deleteDurableQueue" roles="user"/>
           <permission type="createNonDurableQueue" roles="user"/>
           <permission type="deleteNonDurableQueue" roles="user"/>
           <permission type="send" roles="user"/>
           <permission type="consume" roles="user"/>
       </security-setting>
   </security-settings>

   上記の設定では、すべて のキューに特定のパーミッションを ユーザー ロールのメンバーに割り当てます。

3. <broker_instance_dir>/etc/login.config ファイルを開きます。

4. 使用しているディレクトリーサービスに基づいて、LDAP ログインモジュールを設定します。

   1. Microsoft Active Directory ディレクトリーサービスを使用している場合は、以下の例のように設定を追加します。

      activemq {
        org.apache.activemq.artemis.spi.core.security.jaas.LDAPLoginModule required
           debug=true
           initialContextFactory=com.sun.jndi.ldap.LdapCtxFactory
           connectionURL="LDAP://localhost:389"
           connectionUsername="CN=Administrator,CN=Users,OU=System,DC=example,DC=com"
           connectionPassword=redhat.123
           connectionProtocol=s
           connectionTimeout="5000"
           authentication=simple
           userBase="dc=example,dc=com"
           userSearchMatching="(CN={0})"
           userSearchSubtree=true
           readTimeout="5000"
           roleBase="dc=example,dc=com"
           roleName=cn
           roleSearchMatching="(member={0})"
           roleSearchSubtree=true
           ;
      };

      注記

      Microsoft Active Directory を使用し、connectionUsername の属性に指定する必要のある値にスペース (例:OU=System Accounts) が含まれている場合は、値を二重引用符 ("") で囲み、バックスラッシュ (\) を使用してペア内の各二重引用符をエスケープする必要があります。たとえば、connectionUsername="CN=Administrator,CN=Users,OU=\"System Accounts\",DC=example,DC=com" などです。

   2. ApacheDS ディレクトリーサービスを使用している場合は、以下の例のような設定を追加します。

      activemq {
        org.apache.activemq.artemis.spi.core.security.jaas.LDAPLoginModule required
           debug=true
           initialContextFactory=com.sun.jndi.ldap.LdapCtxFactory
           connectionURL="ldap://localhost:10389"
           connectionUsername="uid=admin,ou=system"
           connectionPassword=secret
           connectionProtocol=s
           connectionTimeout=5000
           authentication=simple
           userBase="dc=example,dc=com"
           userSearchMatching="(uid={0})"
           userSearchSubtree=true
           userRoleName=
           readTimeout=5000
           roleBase="dc=example,dc=com"
           roleName=cn
           roleSearchMatching="(member={0})"
           roleSearchSubtree=true
           ;
      };

      debug

      デバッグをオン (true) またはオフ (false) にします。デフォルト値は false です。

      initialContextFactory

      常に com.sun.jndi.ldap.LdapCtxFactory に設定する必要があります。

      connectionURL

      LDAP URL (__<ldap://Host:Port>) を使用するディレクトリーサーバーの場所。オプションでこの URL を修飾するには、スラッシュ / とその後にディレクトリーツリーの特定ノードの DN を追加します。Apache DS のデフォルトポートは 10389 で、Microsoft AD のデフォルト値は 389 です。

      connectionUsername

      ディレクトリーサーバーへの接続を開くユーザーの識別名 (DN)たとえば、uid=admin,ou=system です。ディレクトリーサーバーでは、通常、クライアントが接続を開くためにユーザー名/パスワードの認証情報を提示する必要があります。

      connectionPassword

      connectionUsername の DN に一致するパスワード。Directory Information Tree (DIT) のディレクトリーサーバーでは、パスワードは通常、対応するディレクトリーエントリーに userPassword 属性として保存されます。

      connectionProtocol

      すべての値はサポートされますが、実質的に使用されません。このオプションはデフォルト値がないために明示的に設定する必要があります。

      connectionTimeout

      ブローカーがディレクトリーサーバーに接続することができる最大時間をミリ秒単位で指定します。ブローカーがこの時間内にディレクトリーに接続できない場合、接続の試行を中止します。このプロパティーにゼロまたはそれよりも小さい値を指定すると、代わりに基盤の TCP プロトコルのタイムアウト値が使用されます。値を指定しない場合、ブローカーは接続を無期限に待機するか、または基盤のネットワークがタイムアウトします。

      接続に対して接続プールが要求された場合、このプロパティーは、最大プールサイズにすでに達し、プール内のすべての接続が使用されている場合に、ブローカーが接続を待つ最大時間を指定します。ゼロまたはそれよりも小さい値を指定すると、ブローカーは接続を無期限に利用可能になるまで待機します。それ以外の場合は、ブローカーは最大待機時間に達すると接続の試行を中止します。

      authentication

      LDAP サーバーにバインドする際に使用する認証方法を指定します。このパラメーターは simple (ユーザー名とパスワードが必要) または none (匿名アクセスを許可) のいずれかに設定できます。

      userBase

      ユーザーエントリーを検索する DIT の特定のサブツリーを選択します。サブツリーは、サブツリーのベースノードを指定する DN で指定されます。たとえば、このオプションを ou=User,ou=ActiveMQ,ou=system に設定すると、ユーザーエントリーの検索は ou=User,ou=ActiveMQ,ou=system ノードの下にあるサブツリーに限定されます。

      userSearchMatching

      userBase で選択したサブツリーに適用される LDAP 検索フィルターを指定します。詳細は、以下の 「一致するパラメーターの検索」 セクションを参照してください。

      userSearchSubtree

      userBase で指定されたノードを基準にして、どの程度の深さまでユーザーエントリーの検索を掘り下げるかを指定します。このオプションはブール値です。false の値を指定すると、userBase ノードの子エントリーのいずれかに一致するものの検索を試行します (javax.naming.directory.SearchControls.ONELEVEL_SCOPE にマップ)。true の値を指定すると、userBase ノードの サブ ツリーの配下にあるエントリーに一致するものの検索を試行します (javax.naming.directory.SearchControls.SUBTREE_SCOPE にマップ)。

      userRoleName

      ユーザーのロール名の一覧を含むユーザーエントリーの属性の名前。ロール名は、ブローカーの承認プラグインによってグループ名として解釈されます。このオプションを省略すると、ユーザーエントリーからロール名は抽出されません。

      readTimeout

      ブローカーがディレクトリーサーバーから LDAP 要求への応答を受信するまで待機する最大時間をミリ秒単位で指定します。この時間内にブローカーがディレクトリーサーバーから応答を受信しない場合、ブローカーは要求を中止します。0 または less の値を指定すると、値を指定しないと、ディレクトリーサーバーから LDAP 要求への応答が無期限に待機します。

      roleBase

      ロールデータをディレクトリーサーバーに直接保存する場合は、userRoleName オプションを指定する代わりに (または指定してその上に)、ロールオプション (roleBase、roleSearchMatching、roleSearchSubtree、および roleName) の組み合わせを使用できます。このオプションは、ロール/グループエントリーを検索する DIT の特定のサブツリーを選択します。サブツリーは、サブツリーのベースノードを指定する DN で指定されます。たとえば、このオプションを ou=Group,ou=ActiveMQ,ou=system に設定すると、role/group エントリーの検索が ou=Group,ou=ActiveMQ,ou=system ノードの下にあるサブツリーに限定されます。

      roleName

      ロール/グループの名前が含まれるロールエントリーの属性タイプ (C、O、OU など)。このオプションを省略すると、ロール検索機能は事実上無効になっています。

      roleSearchMatching

      roleBase で選択したサブツリーに適用される LDAP 検索フィルターを指定します。詳細は、以下の 「一致するパラメーターの検索」 セクションを参照してください。

      roleSearchSubtree

      roleBase で指定されたノードを基準にして、どの程度の深さまでロールエントリーの検索を掘り下げるかを指定します。false (デフォルト) に設定すると、roleBase ノードの子エントリー (javax.naming.directory.SearchControls.ONELEVEL_SCOPE にマップ) のいずれかに一致するものの検索を試行します。true の場合、roleBase ノードのサブツリーに属するエントリーに一致するものの検索を試行します (javax.naming.directory.SearchControls.SUBTREE_SCOPE にマップ)。

      注記

      Apache DS は、DN パスの OID 部分を使用します。Microsoft Active Directory は CN 部分を使用します。たとえば、Apache DS では oid=testuser,dc=example,dc=com などの DN パスを使用し、Microsoft Active Directory では cn=testuser,dc=example,dc=com などの DN パスを使用できます。

5. ブローカーを起動または再起動します (サービスまたはプロセス)。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. security-settings 要素内に security-setting-plugin 要素を追加します。以下に例を示します。

   <security-settings>
       <security-setting-plugin class-name="org.apache.activemq.artemis.core.server.impl.LegacyLDAPSecuritySettingPlugin">
           <setting name="initialContextFactory" value="com.sun.jndi.ldap.LdapCtxFactory"/>
           <setting name="connectionURL" value="ldap://localhost:1024"/>`ou=destinations,o=ActiveMQ,ou=system`
           <setting name="connectionUsername" value="uid=admin,ou=system"/>
           <setting name="connectionPassword" value="secret"/>
           <setting name="connectionProtocol" value="s"/>
           <setting name="authentication" value="simple"/>
       </security-setting-plugin>
   </security-settings>

   class-name

   この実装は org.apache.activemq.artemis.core.server.impl.LegacyLDAPSecuritySettingPlugin です。

   initialContextFactory

   LDAP への接続に使用される初期コンテキストファクトリー。これは、常に com.sun.jndi.ldap.LdapCtxFactory (デフォルト値) に設定する必要があります。

   connectionURL

   LDAP URL <ldap://Host:Port> を使用してディレクトリーサーバーの場所を指定します。オプションでこの URL を修飾するには、スラッシュ / とその後にディレクトリーツリーの特定ノードの識別名 (DN) を追加します。例: ldap://ldapserver:10389/ou=systemデフォルト値は ldap://localhost:1024 です。

   connectionUsername

   ディレクトリーサーバーへの接続を開くユーザーの DN。たとえば、uid=admin,ou=system です。ディレクトリーサーバーでは、通常、クライアントが接続を開くためにユーザー名/パスワードの認証情報を提示する必要があります。

   connectionPassword

   connectionUsername の DN に一致するパスワード。Directory Information Tree (DIT) のディレクトリーサーバーでは、パスワードは通常、対応するディレクトリーエントリーに userPassword 属性として保存されます。

   connectionProtocol

   現在は使用されていません。今後、このオプションを使用すると、ディレクトリーサーバーへの接続に Secure Socket Layer(SSL) を選択できます。このオプションはデフォルト値がないために明示的に設定する必要があります。

   authentication

   LDAP サーバーにバインドする際に使用する認証方法を指定します。このパラメーターの有効な値は simple (ユーザー名とパスワード) または none (匿名) です。デフォルト値は simple です。

   注記

   Simple Authentication and Security Layer(SASL) 認証はサポートされ ません。

1. コマンドプロンプトで、mask ユーティリティーを使用してパスワードを暗号化します。

   $ <broker_instance_dir>/bin/artemis mask <password>

   result: 3a34fd21b82bf2a822fa49a8d8fa115d

2. <broker_instance_dir>/etc/login.config ファイルを開きます。connectionPassword パラメーターを見つけます。

   connectionPassword = <password>

3. プレーンテキストのパスワードは、暗号化された値に置き換えます。

   connectionPassword = 3a34fd21b82bf2a822fa49a8d8fa115d

4. 暗号化された値は、識別子 "ENC()" でラップします。

   connectionPassword = "ENC(3a34fd21b82bf2a822fa49a8d8fa115d)"

手順

1. ブローカーを停止します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis stop

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe stop

2. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

3. name-value ペアの saslMechanisms=GSSAPI を acceptor の URL のクエリー文字列に追加します。

   <acceptor name="amqp">
     tcp://0.0.0.0:5672?protocols=AMQP;saslMechanisms=GSSAPI
   </acceptor>

   上記の設定は、Kerberos クレデンシャルの認証時に、アクセプターが GSSAPI メカニズムを使用することを意味します。

4. (オプション) PLAIN および ANONYMOUS SASL メカニズムもサポートされます。複数のメカニズムを指定するには、コンマ区切りリストを使用します。以下に例を示します。

   <acceptor name="amqp">
     tcp://0.0.0.0:5672?protocols=AMQP;saslMechanisms=GSSAPI,PLAIN
   </acceptor>

   結果は、GSSAPI および PLAIN SASL メカニズムの両方を使用するアクセプターです。

5. ブローカーを起動します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis run

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe start

手順

1. ブローカーを停止します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis stop

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe stop

2. <broker_instance_dir>/etc/login.config 設定ファイルを開きます。

3. amqp-sasl-gssapi という名前の設定スコープを追加します。以下の例は、Oracle および OpenJDK バージョンの JDK にある Krb5LoginModule の設定を示しています。

   amqp-sasl-gssapi {
       com.sun.security.auth.module.Krb5LoginModule required
       isInitiator=false
       storeKey=true
       useKeyTab=true
       principal="amqp/my_broker_host@example.com"
       debug=true;
   };

   amqp-sasl-gssapi

   デフォルトでは、ブローカーの GSSAPI メカニズム実装は amqp-sasl-gssapi という名前の JAAS 設定スコープを使用して Kerberos アクセプター認証情報を取得します。

   Krb5LoginModule

   このバージョンの Krb5LoginModule は、Oracle および OpenJDK バージョンの JDK で提供されます。Java ベンダーのドキュメントを参照して、Krb5LoginModule の完全修飾クラス名とその利用可能なオプションを確認します。

   useKeyTab

   Krb5LoginModule は、プリンシパルの認証時に Kerberos キータブを使用するように設定されます。キータブは、Kerberos 環境からツールを使用して生成されます。Kerberos キータブの生成に関する詳細は、ベンダーのドキュメントを参照してください。

   principal

   プリンシパルは amqp/my_broker_host@example.com に設定されます。この値は、Kerberos 環境で作成されたサービスプリンシパルに対応する必要があります。サービスプリンシパルの作成に関する詳細は、ベンダーのドキュメントを参照してください。

4. ブローカーを起動します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis run

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe start

手順

1. ブローカーを停止します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis stop

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe stop

2. <broker_instance_dir>/etc/login.config 設定ファイルを開きます。

3. AMQ Broker Krb5LoginModule および LDAPLoginModule の設定を追加します。LDAP プロバイダーのドキュメントを参照して、設定オプションを確認します。

   以下は設定例です。

   org.apache.activemq.artemis.spi.core.security.jaas.Krb5LoginModule required
       ;
   org.apache.activemq.artemis.spi.core.security.jaas.LDAPLoginModule optional
       initialContextFactory=com.sun.jndi.ldap.LdapCtxFactory
       connectionURL="ldap://localhost:1024"
       authentication=GSSAPI
       saslLoginConfigScope=broker-sasl-gssapi
       connectionProtocol=s
       userBase="ou=users,dc=example,dc=com"
       userSearchMatching="(krb5PrincipalName={0})"
       userSearchSubtree=true
       authenticateUser=false
       roleBase="ou=system"
       roleName=cn
       roleSearchMatching="(member={0})"
       roleSearchSubtree=false
       ;

   注記

   上記の例で示される Krb5LoginModule のバージョンは AMQ Broker で配布され、Kerberos アイデンティティーをロールマッピングに使用できるブローカーアイデンティティーに変換します。

4. ブローカーを起動します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis run

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe start

手順

1. <broker_instance_dir>/etc/boostrap.xml 設定ファイルを編集します。

2. security-manager 要素の class-name 属性に、org.apache.activemq.artemis.spi.core.security.ActiveMQSecurityManager5 インターフェイスのユーザー定義の実装であるクラスを指定します。以下に例を示します。

   <broker xmlns="http://activemq.org/schema">
      ...
      <security-manager class-name="com.foo.MySecurityManager">
         <property key="myKey1" value="myValue1"/>
         <property key="myKey2" value="myValue2"/>
      </security-manager>
      ...
   </broker>

手順

1. カスタムセキュリティーマネージャーの例が含まれるディレクトリーに移動します。

   $ cd <install_dir>/examples/features/standard/security-manager

2. サンプルを実行します。

   $ mvn verify

手順

1. コマンドプロンプトで、mask ユーティリティーを使用してパスワードを暗号化します。

   $ <broker_instance_dir>/bin/artemis mask <password>

   result: 3a34fd21b82bf2a822fa49a8d8fa115d

2. マスクするプレーンテキストのパスワードが含まれる <broker_instance_dir> /etc/broker.xml 設定ファイルを開きます。

   <cluster-password>
     <password>
   </cluster-password>

3. プレーンテキストのパスワードは、暗号化された値に置き換えます。

   <cluster-password>
     3a34fd21b82bf2a822fa49a8d8fa115d
   </cluster-password>

4. 暗号化された値を識別子 ENC() でラップします。

   <cluster-password>
     ENC(3a34fd21b82bf2a822fa49a8d8fa115d)
   </cluster-password>

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

   デフォルトでは、ブローカーは以下のようにジャーナルベースの永続性を使用するように設定されています。

   <configuration>
     <core>
       ...
       <persistence-enabled>true</persistence-enabled>
       <journal-type>ASYNCIO</journal-type>
       <bindings-directory>./data/bindings</bindings-directory>
       <journal-directory>./data/journal</journal-directory>
       <journal-datasync>true</journal-datasync>
       <journal-min-files>2</journal-min-files>
       <journal-pool-files>-1</journal-pool-files>
       <journal-device-block-size>4096</journal-device-block-size>
       <journal-file-size>10M</journal-file-size>
       <journal-buffer-timeout>12000</journal-buffer-timeout>
       <journal-max-io>4096</journal-max-io>
       ...
     </core>
   </configuration>

   persistence-enabled

   このパラメーターの値を true に設定すると、ブローカーはメッセージ永続性にファイルベースのジャーナルを使用します。

   journal-type

   使用するジャーナルのタイプ。ASYNCIO に設定されている場合には、ブローカーはまず AIO の使用を試行します。AIO が見つからない場合、ブローカーは NIO を使用します。

   bindings-directory

   バインディングジャーナルのファイルシステムの場所。デフォルト値は、<broker_instance_dir> ディレクトリーを起点とした相対パスです。

   journal-directory

   メッセージジャーナルのファイルシステムの場所。デフォルト値は、<broker_instance_dir> ディレクトリーを起点とした相対パスです。

   journal-datasync

   このパラメーターの値を true に設定すると、ブローカーは fdatasync 関数を使用してディスク書き込みを確認します。

   journal-min-files

   ブローカーの起動時に最初に作成するジャーナルファイルの数。

   journal-pool-files

   未使用のファイルを回収した後に保持するファイルの数。デフォルト値の -1 は、クリーンアップ中にファイルが削除されないことを意味します。

   journal-device-block-size

   ストレージデバイスのジャーナルが使用するデータブロックの最大サイズ (バイト単位)。デフォルト値は 4096 バイトです。

   journal-file-size

   指定したジャーナルディレクトリーの各ジャーナルファイルの最大サイズ (バイト単位)。この制限に達すると、ブローカーは新規ファイルを起動します。このパラメーターは、バイト表記 (K、M、G など)、または同等のバイナリー (Ki、Mi、Gi) もサポートします。このパラメーターが設定で明示的に指定されていない場合、デフォルト値は 10485760 バイト (10MiB) になります。

   journal-buffer-timeout

   ブローカーがジャーナルバッファーをフラッシュする頻度をナノ秒で指定します。通常、AIO は NIO よりも高いフラッシュレートを使用するため、ブローカーは NIO と AIO の異なるデフォルト値を維持します。このパラメーターが設定で明示的に指定されていない場合、NIO のデフォルト値は 3333333 ナノ秒 (つまり、1 秒あたり 300 回) になります。AIO のデフォルト値は 50000 ナノ秒 (例: 2000 回/秒) です。

   journal-max-io

   いつでも IO キューに格納できる書き込み要求の最大数。キューが満杯になると、ブローカーは領域が利用可能になるまで追加の書き込みをブロックします。

   NIO を使用している場合、この値は常に 1 である必要があります。AIO を使用し、このパラメーターが明示的に設定されていない場合、デフォルト値は 500 になります。

2. 上記の説明に基づいて、ストレージデバイスの必要に応じて永続性設定を調整します。

手順

1. Linux で、ディスク書き込みキャッシュ設定を管理するには、hdparm (IDE ディスクの場合) または sdparm または sginfo (SDSI/SATA ディスクの場合) ツールを使用します。
2. Windows でディスクライターキャッシュ設定を管理するには、ディスクを右クリックします。Properties を選択します。

手順

1. 適切な JDBC クライアントライブラリーをブローカーランタイムに追加します。これを実行するには、関連する .jar ファイルを <broker_instance_dir>/lib ディレクトリーに追加します。
2. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

3. core 要素内に、database-store 要素が含まれる store 要素を追加します。

   <configuration>
     <core>
       <store>
          <database-store>
          </database-store>
       </store>
     </core>
   </configuration>

4. database-store 要素内に JDBC 永続化の設定パラメーターを追加し、値を指定します。以下は例になります。

   <configuration>
     <core>
       <store>
          <database-store>
             <jdbc-connection-url>jdbc:oracle:data/oracle/database-store;create=true</jdbc-connection-url>
             <jdbc-user>ENC(5493dd76567ee5ec269d11823973462f)</jdbc-user>
             <jdbc-password>ENC(56a0db3b71043054269d11823973462f)</jdbc-password>
             <bindings-table-name>BINDINGS_TABLE</bindings-table-name>
             <message-table-name>MESSAGE_TABLE</message-table-name>
             <large-message-table-name>LARGE_MESSAGES_TABLE</large-message-table-name>
             <page-store-table-name>PAGE_STORE_TABLE</page-store-table-name>
             <node-manager-store-table-name>NODE_MANAGER_TABLE</node-manager-store-table-name>
             <jdbc-driver-class-name>oracle.jdbc.driver.OracleDriver</jdbc-driver-class-name>
             <jdbc-network-timeout>10000</jdbc-network-timeout>
             <jdbc-lock-renew-period>2000</jdbc-lock-renew-period>
             <jdbc-lock-expiration>20000</jdbc-lock-expiration>
             <jdbc-journal-sync-period>5</jdbc-journal-sync-period>
          </database-store>
       </store>
     </core>
   </configuration>

   jdbc-connection-url

   データベースサーバーの完全な JDBC 接続 URL。接続 URL には、すべての設定パラメーターとデータベース名が含まれている必要があります。

   jdbc-user

   データベースサーバー用に暗号化されたユーザー名。設定ファイルで使用するユーザー名とパスワードの暗号化に関する詳細は、「設定ファイルのパスワードの暗号化」 を参照してください。

   jdbc-password

   データベースサーバー用に暗号化されたパスワード。設定ファイルで使用するユーザー名とパスワードの暗号化に関する詳細は、「設定ファイルのパスワードの暗号化」 を参照してください。

   bindings-table-name

   データのバインディングが保存されるテーブルの名前。このテーブル名を指定すると、干渉なしに複数のサーバー間で単一のデータベースを共有できます。

   message-table-name

   メッセージデータが保存されるテーブルの名前。このテーブル名を指定すると、干渉なしに複数のサーバー間で単一のデータベースを共有できます。

   large-message-table-name

   サイズの大きいメッセージと関連データが永続化されるテーブルの名前。さらに、クライアントがサイズの大きいメッセージをチャンクでストリーミングする場合に、チャンクはこのテーブルに保存されます。このテーブル名を指定すると、干渉なしに複数のサーバー間で単一のデータベースを共有できます。

   page-store-table-name

   ページストアディレクトリー情報が格納されるテーブルの名前。このテーブル名を指定すると、干渉なしに複数のサーバー間で単一のデータベースを共有できます。

   node-manager-store-table-name

   共有ストア高可用性 (HA) がライブおよびバックアップブローカー向けにロックされ、他の HA 関連のデータがブローカーサーバーに保存されているテーブルの名前。このテーブル名を指定すると、干渉なしに複数のサーバー間で単一のデータベースを共有できます。共有ストア HA を使用する各ライブ/バックアップペアは、同じテーブル名を使用する必要があります。複数の (および関連性のない) ライブ/バックアップペア間で同じテーブルを共有できません。

   jdbc-driver-class-name

   JDBC データベースドライバーの完全修飾クラス名。サポートされるデータベースの詳細は、Red Hat カスタマーポータルの Red Hat AMQ 7 Supported Configurations を参照してください。

   jdbc-network-timeout

   JDBC ネットワーク接続のタイムアウト (ミリ秒単位)。デフォルト値は 20000 ミリ秒です。共有ストア HA に JDBC を使用する場合は、jdbc-lock-expiration 未満の値にタイムアウトを設定することが推奨されます。

   jdbc-lock-renew-period

   現在の JDBC ロックの更新期間の長さ (ミリ秒単位)。この時間が経過すると、ブローカーはロックを更新できます。jdbc-lock-expiration の値の数分の 1 の値を設定することをお勧めします。これにより、ブローカーはリースを延長するのに十分な時間を確保でき、接続に問題が発生した場合にブローカーがロックの更新を試みる時間を確保できます。デフォルト値は 2000 ミリ秒です。

   jdbc-lock-expiration

   jdbc-lock-renew-period の値が経過した場合でも、現在の JDBC ロックが所有 ( 取得または更新 ) されているとみなされる時間 ( ミリ秒単位 )。

   ブローカーは、jdbc-lock-renew-period の値に従って、所有するロックの定期更新を試みます。ブローカーがロックの更新に 失敗 した場合 ( 接続の問題などにより )、ブローカーはロックが最後に正常に取得または更新されてから jdbc-lock-expiration の値が経過するまでロックの更新を試み続けます。

   上記の更新動作の例外は、別のブローカーがロックを取得する場合です。これは、Database Management System (DBMS) とブローカー間の時間の不整合が発生した場合や、ガベージコレクションの一時停止期間が長い場合に発生する可能性があります。この場合、最初にロックを所有していたブローカーは、ロックが失われたと判断し、更新を試行しません。

   有効期限の経過後、現在 JDBC ロックを所有しているブローカーによって JDBC ロックが更新されない場合、別のブローカーが JDBC ロックを確立できます。

   jdbc-lock-expiration のデフォルト値は 20000 ミリ秒です。

   jdbc-journal-sync-period

   ブローカージャーナルが JDBC と同期する期間 ( ミリ秒単位 )。デフォルト値は 5 ミリ秒です。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 以前に JDBC 設定に追加した database-store 要素内で、jdbc-driver-class-name、jdbc-connection-url、jdbc-user、jdbc-password パラメーター を削除します。この手順の後半で、これらの設定は、対応する DBCP 設定パラメーターに置き換えます。

   注記

   上記のパラメーターを明示的に削除しない場合には、この手順の後半で追加する対象の DBCP パラメーターが優先されます。

3. database-store 要素内に data-source-properties 要素を追加します。以下は例になります。

   <store>
       <database-store>
           <data-source-properties>
           </data-source-properties>
           <bindings-table-name>BINDINGS</bindings-table-name>
           <message-table-name>MESSAGES</message-table-name>
           <large-message-table-name>LARGE_MESSAGES</large-message-table-name>
           <page-store-table-name>PAGE_STORE</page-store-table-name>
           <node-manager-store-table-name>NODE_MANAGER_STORE</node-manager-store-table-name>
           <jdbc-network-timeout>10000</jdbc-network-timeout>
           <jdbc-lock-renew-period>2000</jdbc-lock-renew-period>
           <jdbc-lock-expiration>20000</jdbc-lock-expiration>
           <jdbc-journal-sync-period>5</jdbc-journal-sync-period>
       </database-store>
   </store>

4. 新しい data-source-properties 要素内で、接続プールに DBCP データソースプロパティーを追加します。キーと値のペアを指定します。以下は例になります。

   <store>
       <database-store>
           <data-source-properties>
               <data-source-property key="driverClassName" value="com.mysql.jdbc.Driver" />
               <data-source-property key="url" value="jdbc:mysql://localhost:3306/artemis" />
               <data-source-property key="username" value="ENC(5493dd76567ee5ec269d1182397346f)"/>
               <data-source-property key="password" value="ENC(56a0db3b71043054269d1182397346f)"/>
               <data-source-property key="poolPreparedStatements" value="true" />
               <data-source-property key="maxTotal" value="-1" />
           </data-source-properties>
           <bindings-table-name>BINDINGS</bindings-table-name>
           <message-table-name>MESSAGES</message-table-name>
           <large-message-table-name>LARGE_MESSAGES</large-message-table-name>
           <page-store-table-name>PAGE_STORE</page-store-table-name>
           <node-manager-store-table-name>NODE_MANAGER_STORE</node-manager-store-table-name>
           <jdbc-network-timeout>10000</jdbc-network-timeout>
           <jdbc-lock-renew-period>2000</jdbc-lock-renew-period>
           <jdbc-lock-expiration>20000</jdbc-lock-expiration>
           <jdbc-journal-sync-period>5</jdbc-journal-sync-period>
       </database-store>
   </store>

   driverClassName

   JDBC データベースドライバーの完全修飾クラス名。

   url

   データベースサーバーの完全な JDBC 接続 URL。

   username

   データベースサーバー用に暗号化されたユーザー名。この値は、暗号化されていないプレーンテキストとして指定することもできます。設定ファイルで使用するユーザー名とパスワードの暗号化に関する詳細は、「設定ファイルのパスワードの暗号化」 を参照してください。

   password

   データベースサーバー用に暗号化されたパスワード。この値は、暗号化されていないプレーンテキストとして指定することもできます。設定ファイルで使用するユーザー名とパスワードの暗号化に関する詳細は、「設定ファイルのパスワードの暗号化」 を参照してください。

   poolPreparedStatements

   このパラメーターの値を true に設定すると、プールには、無制限の準備済みキャッシュステートメントを追加できます。これにより、初期化コストが削減されます。

   maxTotal

   プールの最大接続数。このパラメーターの値を -1 に設定すると、制限はありません。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. core 要素内に paging-directory 要素を追加します。ファイルシステムのページングディレクトリーの場所を指定します。

   <configuration ...>
     <core ...>
       ...
       <paging-directory>/path/to/paging-directory</paging-directory>
       ...
     </core>
   </configuration>

   その後ページング用に設定するアドレスごとに、ブローカーは指定したページングディレクトリーに専用のディレクトリーを追加します。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 一致するアドレスまたはアドレス セット 用に設定した address-setting 要素の場合は、設定要素を追加して最大メモリー使用量を指定し、ページング動作を定義します。以下は例になります。

   <address-settings>
       <address-setting match="my.paged.address">
           ...
           <max-size-bytes>104857600</max-size-bytes>
           <page-size-bytes>10485760</page-size-bytes>
           <address-full-policy>PAGE</address-full-policy>
           ...
       </address-setting>
   </address-settings>

   max-size-bytes

   ブローカーが address-full-policy に指定されたポリシーを実行する前に、アドレスに許可されるメモリーの最大サイズ ( バイト単位 )。デフォルト値は -1 で、制限なしを意味します。指定する値は、K、MB、GB などのバイト表記もサポートします。

   page-size-bytes

   ページングシステムで使用される各ページファイルのサイズ ( バイト単位 )。デフォルト値は 10485760 ( つまり 10 MiB ) です。指定する値は、K、MB、GB などのバイト表記もサポートします。

   address-full-policy

   アドレスの最大サイズに達したときにブローカーが取るアクション。デフォルト値は PAGE です。有効な値は以下のとおりです。

   PAGE

   ブローカーは、追加のメッセージをディスクにページングします。

   DROP

   ブローカーは追加のメッセージを通知せずに破棄します。

   FAIL

   ブローカーは、クライアントメッセージプロデューサーに対して追加のメッセージおよび例外をドロップします。

   BLOCK

   追加のメッセージを送信しようとすると、クライアントメッセージプロデューサーがブロックされます。

   前述の例に示されて いない 追加のページング設定要素は以下のとおりです。

   page-max-cache-size

   ページングナビゲーション中に IO を最適化するためにブローカーがメモリーに保持するページファイルの数。デフォルト値は 5 です。

   page-sync-timeout

   定期的なページ同期の間隔 ( ナノ秒単位 )。非同期 IO ジャーナルを使用している場合 ( つまり、journal-type が broker.xml 設定ファイルで ASYNCIO に設定されている場合 )、デフォルト値は 3333333 です。標準の Java NIO ジャーナルを使用している場合 ( journal-type が NIO に設定されている場合 )、デフォルト値は journal-buffer-timeout パラメーターの設定済みの値です。

手順

1. ブローカーを停止します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis stop

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe stop

2. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

3. core 要素内に global-max-size 要素を追加し、値を指定します。以下は例になります。

   <configuration>
     <core>
       ...
       <global-max-size>1GB</global-max-size>
       ...
     </core>
   </configuration>

   global-max-size

   ブローカーがすべてのアドレスに使用できるメモリーの合計量 ( バイト単位 )。この制限に達すると、受信メッセージに関連付けられたアドレスに対して、ブローカーは address-full-policy の値として指定されたポリシーを実行します。global-max-size のデフォルト値は、ブローカーをホストする Java 仮想マシン (JVM) で利用可能な最大メモリーの半分です。

   global-max-size の値はバイト単位ですが、バイト表記にも対応します ( 例 : "K"、"Mb"、"GB")。

   上記の例では、ブローカーはメッセージの処理時に利用可能な最大 1 ギガバイトのメモリーを使用するように設定されています。

4. ブローカーを起動します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis run

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe start

手順

1. ブローカーを停止します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis stop

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe stop

2. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

3. core 要素内に max-disk-usage 設定要素を追加し、値を指定します。以下は例になります。

   <configuration>
     <core>
       ...
       <max-disk-usage>50</max-disk-usage>
       ...
     </core>
   </configuration>

   max-disk-usage

   メッセージのページング時にブローカーが使用できる利用可能なディスク領域の最大パーセンテージ。この制限に達すると、ブローカーはページングではなく受信メッセージをブロックします。デフォルト値は 90 です。

   上記の例では、ブローカーはメッセージをページングする際にディスク領域の fifty パーセントの使用に制限されます。

4. ブローカーを起動します。

   1. Linux の場合:

      <broker_instance_dir>/bin/artemis run

   2. Windows の場合:

      <broker_instance_dir>\bin\artemis-service.exe start

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 一致するアドレスまたはアドレス セット 用に設定した address-setting 要素の場合は、メッセージブロック動作を定義する設定要素を追加します。以下は例になります。

   <address-settings>
       <address-setting match="my.blocking.address">
           ...
           <max-size-bytes>300000</max-size-bytes>
           <address-full-policy>BLOCK</address-full-policy>
           ...
       </address-setting>
   </address-settings>

   max-size-bytes

   ブローカーが address-full-policy に指定されたポリシーを実行する前に、アドレスに許可されるメモリーの最大サイズ ( バイト単位 )。指定する値は、K、MB、GB などのバイト表記もサポートします。

   注記

   address-setting 要素で max-size-bytes を指定すると、一致する 各 アドレスに値が適用されます。この値を指定すると、一致するすべてのアドレスの 合計 サイズが max-size-bytes の値に制限されるわけでは ありません。

   address-full-policy

   アドレスの最大サイズに達したときにブローカーが取るアクション。

   上記の例では、アドレス my.blocking.address に送信されたメッセージがメモリーの 300000 バイトを超えると、ブローカーは Core または OpenWire メッセージプロデューサーからの追加のメッセージをブロックします。

手順

1. <broker_instance_dir>/etc/broker.xml 設定ファイルを開きます。

2. 一致するアドレスまたはアドレス セット に設定した address-setting 要素の場合は、メモリーのすべての AMQP メッセージの最大サイズを指定します。以下は例になります。

   <address-settings>
       <address-setting match="my.amqp.blocking.address">
           ...
           <max-size-bytes-reject-threshold>300000</max-size-bytes-reject-threshold>
           ...
       </address-setting>
   </address-settings>

   max-size-bytes-reject-threshold

   ブローカーが AMQP メッセージをさらにブロックする前に、アドレスに許可されるメモリーの最大サイズ ( バイト単位 )。指定する値は、K、MB、GB などのバイト表記もサポートします。デフォルトでは、max-size-bytes-reject-threshold は -1 に設定されます。これは、最大サイズがないことを意味します。

   注記

   address-setting 要素で max-size-bytes-reject-threshold を指定する場合、値は一致する 各 アドレスに適用されます。この値を指定すると、一致するすべてのアドレスの 合計 サイズが max-size-bytes-reject-threshold の値に制限されるわけでは ありません。

手順