ジャンプ先

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

このテンプレートの表示

get

/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}

このテンプレートを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスの名前プロパティ。
• 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

  説明: Adminセキュリティ・ロールのユーザー。
• Deployer: basic
  型: basic

  説明: デプロイヤ・セキュリティ・ロールのユーザー。
• Monitor: basic
  型: basic

  説明: モニター・セキュリティ・ロールのユーザー。
• Operator: basic
  型: basic

  説明: オペレータ・セキュリティ・ロールのユーザー。

トップに戻る

レスポンス

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

• application/json

200レスポンス

このテンプレートを返します。

このメソッドは次のリンクを返すことができます。

• rel=action title=findErrorDestination uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/findErrorDestination

  このリソースのfindErrorDestinationアクション・リソース。

• rel=deliveryFailureParams uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/deliveryFailureParams

  このリソースのdeliveryFailureParamsシングルトン・リソース。

• rel=deliveryParamsOverrides uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/deliveryParamsOverrides

  このリソースのdeliveryParamsOverridesシングルトン・リソース。

• rel=groupParams uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/groupParams

  このリソースのgroupParamsコレクション・リソース。

• rel=messageLoggingParams uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/messageLoggingParams

  このリソースのmessageLoggingParamsシングルトン・リソース。

• rel=multicast uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/multicast

  このリソースのmulticastシングルトン・リソース。

• rel=quota

  割当てリソースへのこのリソースの割当て参照。

• rel=thresholds uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/thresholds

  このリソースのthresholdsシングルトン・リソース。

• rel=topicSubscriptionParams uri=/management/weblogic/{version}/domainConfig/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates/{name}/topicSubscriptionParams

  このリソースのtopicSubscriptionParamsシングルトン・リソース。

本文 ()

ルート・スキーマ: テンプレート

型: object

ソースの表示

• attachSender(optional): string
  デフォルト値: supports

  指定可能な値: [ "supports"、"never"、"always" ]

  このテンプレートを使用する宛先に届くメッセージに送信側ユーザーの資格証明が添付されている必要があるかどうかを指定します。

  • Supports 必要な場合は、JMSXUserIDプロパティが送信側ユーザーのセキュリティ・プリンシパルに設定されます。ConnectionFactoryでAttachJMSXUserID="true"と指定することにより、送信側はメッセージにIDを添付するようにリクエストできます。

  • Never JMSXUserIDプロパティは、送信側ユーザーのセキュリティ・プリンシパルに設定されません。

  • Always JMSXUserIDプロパティは、送信側ユーザーのセキュリティ・プリンシパルに常に設定されます。

  このプロパティは動的に構成できます。動的に変更した場合は、更新後に受信したメッセージにのみ影響します。

• consumptionPausedAtStartup(optional): boolean
  デフォルト値: false

  サーバー起動時にこのテンプレートを使用する宛先で、メッセージの消費が休止されるかどうかを指定します。

  • false サーバー起動時のメッセージ消費の休止がこのテンプレートでは無効化されます。

  • true サーバー起動時のメッセージ消費の休止がこのテンプレートでは有効化されます。

• defaultUnitOfOrder(optional): boolean
  デフォルト値: false

  ドメイン、JMSサーバー、宛先名に基づいて、システムで生成される順序単位名をWebLogic Serverが作成するかどうかを指定します。この宛先に届き、まだ順序単位に属していないメッセージは、このデフォルト名を割り当てられます。

  このフィールドは、高度な使用にお薦めします。一般的には、アプリケーションの呼出しまたは接続ファクトリ構成を使用してメッセージの順序単位を設定することをお薦めします。分散宛先での強制的な順序付けで宛先のデフォルトの順序単位に依存する場合、アプリケーションでは順序単位のルーティングが適用されないことを認識している必要があります。かわりに、アプリケーションでは、処理の失敗やサービスの移行が発生した場合でも、順番に処理する必要がある特定のメッセージ・セットが指定された同一のメンバー宛先にすべて送信されるように、特別に注意する必要があります。

• destinationKeys(optional): array 項目
  タイトル: Items

  このJMSテンプレートを使用する宛先に届くメッセージのソートに使用できる宛先キーのリスト。

  キーは最上位から最下位の順に順序付けられます。複数のキーが指定されている場合、JMSMessageIDに基づいたキーはリストの最後のキーになります。

  ノート: JMSMessageIDがキーに定義されていない場合は、暗黙的にそれが最後のキーと仮定され、ソート順序は「昇順」(FIFO)に設定されます。

• id(optional): integer(int64)
  読取り専用: true

  このBeanインスタンスの一意の識別子を返します。

• incompleteWorkExpirationTime(optional): integer(int32)
  デフォルト値: -1

  未完了のUOW内の未配信メッセージが期限切れになるまでの最長時間(ミリ秒)を指定します。そのようなメッセージはその後、未配信メッセージに対して定義されている、テンプレートの有効期限ポリシーに従います。

  ノート: UOWメッセージのためのテンプレートのエラー宛先は、「単一のメッセージ配信」値を使用するように構成することはできません。

• insertionPausedAtStartup(optional): boolean
  デフォルト値: false

  サーバー起動時にこのテンプレートを使用する宛先で、新しいメッセージの挿入が休止されるかどうかを指定します。

  • false サーバー起動時のメッセージ挿入の休止がこのテンプレートでは無効化されます。

  • true サーバー起動時のメッセージ挿入の休止がこのテンプレートでは有効化されます。

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

  最大値: 2147483647

  デフォルト値: 2147483647

  この宛先でプロデューサから受信するメッセージの最大サイズ。メッセージのサイズには、メッセージの本文、ユーザー定義のプロパティ、ユーザー定義のJMSヘッダー・フィールド(JMSCorrelationIDおよびJMSType)が含まれます。

  宛先のメッセージの最大サイズの設定を超えるメッセージをプロジューサが送信すると、ResourceAllocationExceptionが発生します。

  最大メッセージ・サイズは、メッセージの最初の生成に対してのみ適用されます。エラー宛先に転送されるメッセージや、分散宛先のメンバーに転送されるメッセージは、サイズをチェックされません。たとえば、宛先の最大メッセージ・サイズが128KB、対応するエラー宛先の最大メッセージ・サイズが64KBで構成されている場合、96KBのメッセージは(64KBを超えても)エラー宛先にリダイレクトできますが、プロデューサが96KBのメッセージをエラー宛先に直接送信することはできません。

  最大メッセージ・サイズは動的に構成できますが、受信するメッセージのみ影響を受けます。保存されているメッセージには影響しません。

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

  最大値: 100

  デフォルト値: 25

  このテンプレートを使用する宛先が、コンシューマに配信する消費可能なメッセージ(存在する場合)の完全なバッチを作成するまでに待機できる期間の長さを制御します。最小値の場合、バッチ処理は無効化されます。デフォルト値の場合、完全でないバッチは待機せずに、ただちに現在消費可能なメッセージによる配信が行われます。デフォルト値より大きい値にチューニングすることで、完全でないバッチがコンシューマに配信される前に、さらなるメッセージに対する最長待機時間を制御できます。

  完全なバッチの最大メッセージ数は、JMS接続ファクトリの「最大メッセージ数」の設定によって制御されます。

• name(optional): string
  読取り専用: true

  このエンティティの名前。XMLでは属性として示されます。

  JMSモジュール内の要素の多くは名前付きのエンティティです。XMLファイル内で、ある型に含まれる名前付きエンティティは、すべて一意でなければなりません。これは、JMSモジュール内で特定のエンティティを区別するための識別子です。

  この属性は、モジュールの内部で参照される可能性があるため、モジュールの外から(たとえば、デプロイメント・プランで)変更することはできません。

  制約

  • 有効なNULL
• notes(optional): string

  この名前付きJMSディスクリプタBeanの説明に含めることのできるオプションの情報。

  JMSモジュールはこのノートをJMSディスクリプタ・ファイルにXML PCDATAとして保存します。すべての左山カッコ(<)はxmlエンティティに変換されます<) are converted to the xml entity <。改行/行送りは保持されます</)>。

  ノート:

  管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• productionPausedAtStartup(optional): boolean
  デフォルト値: false

  サーバー起動時に、このテンプレートを使用する宛先で、新しいメッセージの生成が休止されるかどうかを指定します。

  • false サーバー起動時のメッセージ生成の休止がこのテンプレートでは無効化されます。

  • true サーバー起動時のメッセージ生成の休止がこのテンプレートでは有効化されます。

• quota(optional): array 割当て参照
  タイトル: Quota Reference

  割当て参照が含まれます。

  Quotaは、宛先で使用できるシステム・リソースの割当てを制御します。たとえば、宛先で格納できるバイト数をQuotaBeanを使用して構成できます。

• safExportPolicy(optional): string
  デフォルト値: All

  指定可能な値: [ "All"、"None" ]

  ユーザーが、ストア・アンド・フォワードを使用して、このテンプレートを使用する宛先にメッセージを送信できるかどうかを指定します。

  • All すべてのユーザーが、ストア・アンド・フォワードを使用して宛先にメッセージを送信できます。

  • None リモート・ユーザーは、ストア・アンド・フォワードを使用して宛先にメッセージを送信できません。

  このプロパティは動的に構成できます。動的に変更した場合は、更新後に送信されたメッセージにのみ影響します。

• unitOfWorkHandlingPolicy(optional): string
  デフォルト値: PassThrough

  指定可能な値: [ "PassThrough"、"SingleMessageDelivery" ]

  このテンプレートを使用する宛先で、作業単位(UOW)機能を有効化するかどうかを指定します。UOWは1つの単位として処理されるメッセージのセットです。

  • PassThrough デフォルトでは、このテンプレートを使用する宛先はメッセージをUOWの一部として処理しません。

  • SingleMessageDelivery この値は、UOWコンシューマでこのテンプレートを使用する宛先に対するメッセージを受信している場合にのみ選択します。選択した場合、UOWメッセージはリストになり、そのリストを格納したObjectMessageとして消費されます。

{
    "type":"object",
    "properties":{
        "attachSender":{
            "default":"supports",
            "enum":[
                "supports",
                "never",
                "always"
            ],
            "type":"string",
            "description":"<p>Specifies whether messages landing on destinations that use this template should attach the credential of the sending user.</p><ul><li><p><b>Supports</b> The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a ConnectionFactory with <code>AttachJMSXUserID=\"true\"</code></p></li><li><p><b>Never</b> The JMSXUserID property is never be set with the security principal of the sending user.</p></li><li><p><b>Always</b> The JMSXUserID property is always set with the security principal of the sending user.</p></li></ul><p>This property is dynamically configurable. A dynamic change will only affect messages received after the update has been made.</p>"
        },
        "consumptionPausedAtStartup":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether message consumption is paused on destinations that use this template at server startup.</p><ul><li><p><b>false</b> Paused message consumption at server startup is disabled on this template.</p></li><li><p><b>true</b> Paused message consumption at server startup is enabled on this template.</p></li></ul>"
        },
        "defaultUnitOfOrder":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.</p><p>This field is recommended for advanced use. Generally, it is  recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with adistributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration. </p>"
        },
        "destinationKeys":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The list of potential destination keys for sorting messages that arrive on destinations that use this JMS template.</p><p>The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.</p><p><b>Note:</b> If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as \"Ascending\" (FIFO) for the sort order.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "incompleteWorkExpirationTime":{
            "default":-1,
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the maximum amount of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the template's expiration policy defined for undeliverable messages.</p><p><b>Note:</b> A template's error destination for UOW messages cannot be configured to use the <b>Single Message Delivery</b> value.</p>"
        },
        "insertionPausedAtStartup":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether new message insertion is paused on destinations that use this template at server startup.</p><ul><li><p><b>false</b> Paused message insertion at server startup is disabled on this template.</p></li><li><p><b>true</b> Paused message insertion at server startup is enabled on this template.</p></li></ul>"
        },
        "maximumMessageSize":{
            "default":2147483647,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum size of a message that will be accepted from producers on this destination. The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: <code>JMSCorrelationID</code> and <code>JMSType</code></p><p>Producers sending messages that exceed the configured maximum message size for the destination receive a <code>ResourceAllocationException</code> .</p><p>The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.</p><p>Maximum Message Size is dynamically configurable, but only incoming messages are affected; stored messages are not affected.</p>"
        },
        "messagingPerformancePreference":{
            "default":25,
            "minimum":0,
            "maximum":100,
            "type":"integer",
            "format":"int32",
            "description":"<p>Controls how long destinations that use this template are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.</p><p>The maximum message count of a full batch is controlled by the JMS connection factory's MessagesMaximum setting.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The name of this entity, represented in XML as an attribute.</p><p> Many of the elements within the JMS module are named entities.  All of the named entities encased by a type in the XML file must be unique.  This is the identifier used to delineate a particular entity within the JMS module. </p><p> This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially. </p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this named JMS descriptor bean.</p><p>JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><dl><dt>Note:</dt><dd><p>If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p></dd></dl>"
        },
        "productionPausedAtStartup":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether new message production on destinations that use this template is paused on at server startup.</p><ul><li><p><b>false</b> Paused message production at server startup is disabled on this template.</p></li><li><p><b>true</b> Paused message production at server startup is enabled on this template.</p></li></ul>"
        },
        "quota":{
            "title":"Quota Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the quota reference. <p>A Quota controls the allotment of system resources available to destinations. For example the number of bytes a destination is allowed to store can be configured with a QuotaBean.</p>"
        },
        "safExportPolicy":{
            "default":"All",
            "enum":[
                "All",
                "None"
            ],
            "type":"string",
            "description":"<p>Specifies whether a user can send messages to destinations that use this template using Store-and-Forward.</p><ul><li><p><b>All</b> All users can send messages to destinations using Store-and-Forward.</p></li><li><p><b>None</b> Remote users cannot send messages to destinations using Store-and-Forward. </p></li></ul><p>This property is dynamically configurable. A dynamic change will only affect messages sent after the update has been made.</p>"
        },
        "unitOfWorkHandlingPolicy":{
            "default":"PassThrough",
            "enum":[
                "PassThrough",
                "SingleMessageDelivery"
            ],
            "type":"string",
            "description":"<p>Specifies whether the Unit-of-Work (UOW) feature is enabled for destinations that use this template. A UOW is a set of messages that are processed as a single unit.</p><ul><li><p><b>Pass-Through</b> By default, destinations that use this template do not treat messages as part of a UOW.</p></li><li><p><b>Single Message Delivery</b> This value should only be selected if UOW consumers are receiving messages on destinations that use this template. When selected, UOW messages are formed into a list and are consumed as an <code>ObjectMessage</code> containing the list.</p></li></ul>"
        }
    },
    "description":""
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

このJMSテンプレートを使用する宛先に届くメッセージのソートに使用できる宛先キーのリスト。

キーは最上位から最下位の順に順序付けられます。複数のキーが指定されている場合、JMSMessageIDに基づいたキーはリストの最後のキーになります。

ノート: JMSMessageIDがキーに定義されていない場合は、暗黙的にそれが最後のキーと仮定され、ソート順序は「昇順」(FIFO)に設定されます。

ソースの表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The list of potential destination keys for sorting messages that arrive on destinations that use this JMS template.</p><p>The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.</p><p><b>Note:</b> If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as \"Ascending\" (FIFO) for the sort order.</p>"
}

ネストされたスキーマ: 割当て参照

型: array

タイトル: Quota Reference

割当て参照が含まれます。

Quotaは、宛先で使用できるシステム・リソースの割当てを制御します。たとえば、宛先で格納できるバイト数をQuotaBeanを使用して構成できます。

ソースの表示

• 配列: string

{
    "title":"Quota Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the quota reference. <p>A Quota controls the allotment of system resources available to destinations. For example the number of bytes a destination is allowed to store can be configured with a QuotaBean.</p>"
}

トップに戻る