Create A New Template
/management/weblogic/{version}/edit/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/templates
Add a new template to this collection.
Request
- application/json
-
name: string
The name property of the instance in the collection.
-
version: string
The version of the WebLogic REST interface.
-
X-Requested-By: string
The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.
Must contain a populated template model.
object
-
attachSender(optional):
string
Default Value:
supports
Allowed Values:[ "supports", "never", "always" ]
Specifies whether messages landing on destinations that use this template should attach the credential of the sending user.
Supports 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
AttachJMSXUserID="true"
Never The JMSXUserID property is never be set with the security principal of the sending user.
Always The JMSXUserID property is always set with the security principal of the sending user.
This property is dynamically configurable. A dynamic change will only affect messages received after the update has been made.
-
consumptionPausedAtStartup(optional):
boolean
Default Value:
false
Specifies whether message consumption is paused on destinations that use this template at server startup.
false Paused message consumption at server startup is disabled on this template.
true Paused message consumption at server startup is enabled on this template.
-
defaultUnitOfOrder(optional):
boolean
Default Value:
false
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.
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.
-
destinationKeys(optional):
array Items
Title:
Items
The list of potential destination keys for sorting messages that arrive on destinations that use this JMS template.
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.
Note: 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.
-
id(optional):
integer(int64)
Read Only:
true
Return the unique identifier of this bean instance.
-
incompleteWorkExpirationTime(optional):
integer(int32)
Default Value:
-1
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.
Note: A template's error destination for UOW messages cannot be configured to use the Single Message Delivery value.
-
insertionPausedAtStartup(optional):
boolean
Default Value:
false
Specifies whether new message insertion is paused on destinations that use this template at server startup.
false Paused message insertion at server startup is disabled on this template.
true Paused message insertion at server startup is enabled on this template.
-
maximumMessageSize(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2147483647
Default Value:2147483647
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:
JMSCorrelationID
andJMSType
Producers sending messages that exceed the configured maximum message size for the destination receive a
ResourceAllocationException
.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.
Maximum Message Size is dynamically configurable, but only incoming messages are affected; stored messages are not affected.
-
messagingPerformancePreference(optional):
integer(int32)
Minimum Value:
0
Maximum Value:100
Default Value:25
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.
The maximum message count of a full batch is controlled by the JMS connection factory's MessagesMaximum setting.
-
name(optional):
string
Read Only:
true
The name of this entity, represented in XML as an attribute.
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.
This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.
Constraints
- legal null
-
notes(optional):
string
Optional information that you can include to describe this named JMS descriptor bean.
JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the xml entity
<. Carriage returns/line feeds are preserved.)>
- Note:
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
-
productionPausedAtStartup(optional):
boolean
Default Value:
false
Specifies whether new message production on destinations that use this template is paused on at server startup.
false Paused message production at server startup is disabled on this template.
true Paused message production at server startup is enabled on this template.
-
quota(optional):
array Quota Reference
Title:
Quota Reference
Contains the quota reference.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.
-
safExportPolicy(optional):
string
Default Value:
All
Allowed Values:[ "All", "None" ]
Specifies whether a user can send messages to destinations that use this template using Store-and-Forward.
All All users can send messages to destinations using Store-and-Forward.
None Remote users cannot send messages to destinations using Store-and-Forward.
This property is dynamically configurable. A dynamic change will only affect messages sent after the update has been made.
-
unitOfWorkHandlingPolicy(optional):
string
Default Value:
PassThrough
Allowed Values:[ "PassThrough", "SingleMessageDelivery" ]
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.
Pass-Through By default, destinations that use this template do not treat messages as part of a UOW.
Single Message Delivery 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
ObjectMessage
containing the list.
array
Items
The list of potential destination keys for sorting messages that arrive on destinations that use this JMS template.
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.
Note: 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.
array
Quota Reference
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.
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.