ジャンプ先

• リクエスト
• レスポンス

このデフォルト配信パラメータの表示

get

/management/weblogic/{version}/serverConfig/JMSSystemResources/{name}/JMSResource/connectionFactories/{name}/defaultDeliveryParams

このデフォルト配信パラメータを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスのnameプロパティ。
• version: string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields(optional): string
  'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。注意: 'excludeFields'が指定されている場合、'fields'を指定しないでください。
• excludeLinks(optional): string
  'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。注意: 'excludeLinks'が指定されている場合、'links'を指定しないでください。
• fields(optional): string
  'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。注意: 'fields'が指定されている場合、'excludeFields'を指定しないでください。
• links(optional): string
  'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。注意: 'links'が指定されている場合、'excludeLinks'を指定しないでください。

セキュリティ

• Admin: basic
  型: Basic

  説明: A user in the Admin security role.
• デプロイヤ: 基本
  型: Basic

  説明: A user in the Deployer security role.
• モニター: 基本
  型: Basic

  説明: A user in the Monitor security role.
• オペレータ: 基本
  型: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

このデフォルト配信パラメータを返します。

本文()

ルート・スキーマ: デフォルト配信パラメータ

型: object

ソースの表示

• defaultCompressionThreshold(optional): integer(int32)
  最小値: 0

  最大値: 2147483647

  デフォルト値: 2147483647

  シリアライズされたメッセージ本文のバイト数。任意のメッセージがこの制限を超過すると、JMSメッセージ・プロデューサまたまコンシューマによってそのメッセージが送信または受信されたときに、メッセージは圧縮されます。

  圧縮は次のいずれかの場合に発生します。

  • JMSメッセージ・プロデューサのJVMがJMSプロバイダのJVMと連結していない場合に、メッセージ本文のサイズがしきい値の制限を超過すると、JMSメッセージ・プロデューサのJVMで圧縮されます。

  • JMSメッセージ・コンシューマのJVMがJMSプロバイダのJVMと連結していない場合に、メッセージ本文のサイズがしきい値の制限を超過すると、JMSプロバイダのJVMで圧縮されます。

• defaultDeliveryMode(optional): string
  デフォルト値: Persistent

  使用可能な値: [ "Persistent", "Non-Persistent" ]

  メッセージに配信モードが明示的に定義されていない場合に使用されるデフォルトの配信モード。

  このファクトリで作成された接続で生成され、DefaultDeliveryModeにnullが指定されているすべてのメッセージは、この値を受け取ります。 javax.jms.MessageProducer.getDeliveryMode()メソッドを呼び出すと、メッセージ・プロデューサは明示的に配信モードを取得できます。

  この属性は動的です。いつでも変更できます。ただし、値を変更しても既存の接続には影響しません。この接続ファクトリで作成された新しい接続にのみ影響します。

• defaultPriority(optional): integer(int32)
  最小値: 0

  最大値: 9

  デフォルト値: 4

  メッセージに優先度が明示的に定義されていない場合に使用するデフォルトの優先度。

  このファクトリで作成された接続で生成され、DefaultPriorityに -1が指定されているすべてのメッセージは、この値を受け取ります。javax.jms.MessageProducer.getPriority()メソッドを呼び出すと、メッセージ・プロデューサは明示的に優先度を取得できます。

  この属性は動的です。いつでも変更できます。ただし、値を変更しても既存の接続には影響しません。この接続ファクトリで作成された新しい接続にのみ影響します。

• defaultRedeliveryDelay(optional): integer(int64)
  最小値: 0

  最大値: 9.223372036854776E18

  デフォルト値: 0

  ロールバックまたは回復されたメッセージが再配信されるまでの遅延時間(ミリ秒)。

  このファクトリで作成されたコンシューマによって消費され、DefaultRedeliveryDelayに -1が指定されているすべてのメッセージは、この値を使用します。

  weblogic.jms.extensions.WLSession.getRedliveryDelay()メソッドを呼び出すと、メッセージ・コンシューマは明示的に再配信遅延時間を取得できます。

  この属性は動的です。いつでも変更できます。ただし、値を変更しても既存の接続には影響しません。この接続ファクトリで作成された新しい接続にのみ影響します。

• defaultTimeToDeliver(optional): string
  デフォルト値: 0

  メッセージが生成されてからその宛先で表示できるようになるまでの遅延時間(ミリ秒)。

  このファクトリで作成されたプロデューサによって生成され、DefaultTimeToDeliverに -1が指定されているすべてのメッセージは、この値を使用します。 weblogic.jms.extensions.WLMessageProducer.getTimeToDeliver()メソッドを呼び出すと、メッセージ・プロデューサは明示的に配信時間を取得できます。

  この属性は動的です。いつでも変更できます。ただし、値を変更しても既存の接続には影響しません。この接続ファクトリで作成された新しい接続にのみ影響します。

• defaultTimeToLive(optional): integer(int64)
  最小値: 0

  最大値: 9.223372036854776E18

  デフォルト値: 0

  メッセージの最大存在時間を示すミリ秒数。この値は、この接続ファクトリを使用する送信側のアプリケーションでtime-to-liveが明示的に設定されない場合およびtime-to-liveが宛先のTimeToLiveOverride属性によって明示的にオーバーライドされない場合に使用されます。値0は、メッセージが無期限に存続することを示します。

  メッセージ・プロデューサ・アプリケーションでは、標準のJMS javax.jms.MessageProducer.setTimeToLive(long)メソッドを呼び出すことにより、time-to-liveを明示的に設定できます。javax.jms.Message.setJMSExpiration()を使用してプログラムからtime-to-liveを設定しても効果はありません。JMS仕様に従って、メッセージ・セッターはJMS送信呼出しで無視されます。

  この属性は動的です。いつでも変更できます。ただし、値を変更しても既存の接続には影響しません。この接続ファクトリで作成された新しい接続にのみ影響します。

• defaultUnitOfOrder(optional): string

  この接続ファクトリを使用して接続するプロデューサのデフォルトの順序単位名。順序単位を使用すると、複数の宛先間でもメッセージを特定の順序で処理できるようになります。

  「システム生成」は、順序単位名が自動的に生成されることを示します。「ユーザー生成」は、順序単位名フィールドに指定された名前が採用されることを示します。「なし」を選択した場合、メッセージの順序は強制されません。

  制約

  • 有効なnull
• sendTimeout(optional): integer(int64)
  最小値: 0

  最大値: 9.223372036854776E18

  デフォルト値: 10

  宛先に、送信されようとしているメッセージ用に利用できる領域が十分にない(割当てがない)場合に、送信側が待機する最長時間(ミリ秒)。

  デフォルトの時間は10ミリ秒です。値0は、送信側で領域ができるまで待機しないことを示します。

  この属性は動的です。いつでも変更できます。ただし、値を変更しても既存の接続またはその接続のプロデューサには影響しません。この接続ファクトリで作成された新しい接続にのみ影響します。プロデューサでは、そのセッションおよび接続の作成に使用した接続ファクトリから設定を継承します。この値は、実行時にプロデューサに値を設定することによってオーバーライドされる場合があります。

{
    "type":"object",
    "properties":{
        "defaultCompressionThreshold":{
            "default":2147483647,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of bytes for the serialized message body so any message exceeds this limit will trigger message compression when the message is sent or received by the JMS message producer or consumer.</p><p>The compression will occur either:</p><ul><li><p> On the JMS message producer's JVM if the JMS message producer's JVM is not collocated with the JMS provider's JVM and the message body size exceeds the threshold limit. </p></li><li><p> On the JMS provider's JVM when the JMS message consumer's JVM is not collocated with the JMS provider's JVM and the message body size exceeds the threshold limit. </p></li></ul>"
        },
        "defaultDeliveryMode":{
            "default":"Persistent",
            "enum":[
                "Persistent",
                "Non-Persistent"
            ],
            "type":"string",
            "description":"<p>The default delivery mode used for messages when a delivery mode is not explicitly defined. </p><p>All messages with a DefaultDeliveryMode of <code>null</code> that are produced on a connection created with this factory will receive this value. Message producers can get the delivery mode explicitly by calling the <code> javax.jms.MessageProducer.getDeliveryMode()</code> method.</p><p>This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.</p>"
        },
        "defaultPriority":{
            "default":4,
            "minimum":0,
            "maximum":9,
            "type":"integer",
            "format":"int32",
            "description":"<p>The default priority used for messages when a priority is not explicitly defined.</p><p>All messages with a DefaultPriority of -1 that are produced on a connection created with this factory will receive this value. Message producers can get the priority explicitly by calling the <code>javax.jms.MessageProducer.getPriority()</code> method.</p><p>This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.</p>"
        },
        "defaultRedeliveryDelay":{
            "default":0,
            "minimum":0,
            "maximum":9.223372036854776E18,
            "type":"integer",
            "format":"int64",
            "description":"<p>The delay time, in milliseconds, before rolled back or recovered messages are redelivered.</p><p>All messages consumed by a consumer created with this factory that have a DefaultRedeliveryDelay of -1 will use this value.</p><p>Message consumers can get the redelivery delay explicitly by calling the <code> weblogic.jms.extensions.WLSession.getRedliveryDelay()</code> method. </p><p>This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.</p>"
        },
        "defaultTimeToDeliver":{
            "default":"0",
            "type":"string",
            "description":"<p>The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination.</p><p>All messages produced by a producer created with this factory that have a DefaultTimeToDeliver of -1 will use this value. Message producers can get the Time-to-Deliver explicitly by calling the <code> weblogic.jms.extensions.WLMessageProducer.getTimeToDeliver()</code> method.</p><p>This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.</p>"
        },
        "defaultTimeToLive":{
            "default":0,
            "minimum":0,
            "maximum":9.223372036854776E18,
            "type":"integer",
            "format":"int64",
            "description":"<p>The maximum length of time, in milliseconds, that a message exists. This value is used for messages when both the <code>time-to-live</code> is not explicitly set by the sender application that is using this connection factory and the <code>time-to-live</code> is not explicitly overridden by the destination's <code>TimeToLiveOverride</code> attribute . A value of 0 indicates that the message has an infinite amount time to live. </p><p>Message producer applications can set the <code>time-to-live</code> explicitly by calling the standard JMS <code>javax.jms.MessageProducer.setTimeToLive(long)</code> method. Note that programmatically setting <code>time-to-live</code> using <code>javax.jms.Message.setJMSExpiration()</code> has no effect - the message setter is ignored by  the JMS send call as required by the JMS specification. </p><p>This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections. It only affects new connections made with this connection factory.</p>"
        },
        "defaultUnitOfOrder":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The default Unit-of-Order name for producers that connect using this connection factory. A Unit-of-Order allows for messages to be processed in a certain order, even among multiple recipients.</p><p><code>System-generated</code> indicates that WebLogic Server will automatically generate a Unit-of-Order name. <code>User-Generated</code> indicates that the Unit-of-Order name will come from the name specified name in the <code>Unit-of-Order Name</code> field. If <code>None</code> is selected, no message ordering is enforced.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "sendTimeout":{
            "default":10,
            "minimum":0,
            "maximum":9.223372036854776E18,
            "type":"integer",
            "format":"int64",
            "description":"<p>The maximum length of time, in milliseconds, that a sender will wait when there isn't enough available space (no quota) on a destination to accommodate the message being sent.</p><p>The default time is 10 milliseconds. A value of 0 indicates that the sender does not want to wait for space. </p><p>This attribute is dynamic. It can be changed at any time. However, changing the value does not affect existing connections or their producers. It only affects new connections made with this connection factory. Producers inherit the setting from the connection factory used to create their session and connection. The value can then be overridden at run time by setting the value on the producer. </p>"
        }
    },
    "description":""
}

先頭に戻る