RESTful Domain Configuration Management Interface for Oracle WebLogic Server

View This Default Delivery Params

get

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

View this default delivery params.

Request

Path Parameters

name: string

The name property of the instance in the collection.
version: string

The version of the WebLogic REST interface.

Query Parameters

excludeFields(optional): string

The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
excludeLinks(optional): string

The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
fields(optional): string

The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
links(optional): string

The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Deployer: basic

Type: basic

Description: A user in the Deployer security role.
Monitor: basic

Type: basic

Description: A user in the Monitor security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Returns this default delivery params.

Root Schema : Default Delivery Params

Type: object

Show Source

defaultCompressionThreshold(optional): integer(int32)
Minimum Value: 0

Maximum Value: 2147483647

Default Value: 2147483647
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.
The compression will occur either:
- 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.
- 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.
defaultDeliveryMode(optional): string

Default Value: Persistent

Allowed Values: [ "Persistent", "Non-Persistent" ]

The default delivery mode used for messages when a delivery mode is not explicitly defined.
All messages with a DefaultDeliveryMode of null 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 javax.jms.MessageProducer.getDeliveryMode() method.
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.
defaultPriority(optional): integer(int32)

Minimum Value: 0

Maximum Value: 9

Default Value: 4

The default priority used for messages when a priority is not explicitly defined.
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 javax.jms.MessageProducer.getPriority() method.
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.
defaultRedeliveryDelay(optional): integer(int64)

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Default Value: 0

The delay time, in milliseconds, before rolled back or recovered messages are redelivered.
All messages consumed by a consumer created with this factory that have a DefaultRedeliveryDelay of -1 will use this value.
Message consumers can get the redelivery delay explicitly by calling the weblogic.jms.extensions.WLSession.getRedliveryDelay() method.
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.
defaultTimeToDeliver(optional): string

Default Value: 0

The delay time, in milliseconds, between when a message is produced and when it is made visible on its destination.
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 weblogic.jms.extensions.WLMessageProducer.getTimeToDeliver() method.
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.
defaultTimeToLive(optional): integer(int64)

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Default Value: 0

The maximum length of time, in milliseconds, that a message exists. This value is used for messages when both the time-to-live is not explicitly set by the sender application that is using this connection factory and the time-to-live is not explicitly overridden by the destination's TimeToLiveOverride attribute . A value of 0 indicates that the message has an infinite amount time to live.
Message producer applications can set the time-to-live explicitly by calling the standard JMS javax.jms.MessageProducer.setTimeToLive(long) method. Note that programmatically setting time-to-live using javax.jms.Message.setJMSExpiration() has no effect - the message setter is ignored by the JMS send call as required by the JMS specification.
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.
defaultUnitOfOrder(optional): string
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.
System-generated indicates that WebLogic Server will automatically generate a Unit-of-Order name. User-Generated indicates that the Unit-of-Order name will come from the name specified name in the Unit-of-Order Name field. If None is selected, no message ordering is enforced.
Constraints
- legal null
sendTimeout(optional): integer(int64)

Minimum Value: 0

Maximum Value: 9.223372036854776E18

Default Value: 10

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.
The default time is 10 milliseconds. A value of 0 indicates that the sender does not want to wait for space.
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.

{
    "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":""
}