4.12. 期限切れのメッセージを期限切れアドレスに移動する

手順

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

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