RESTful Edit Management Interface for Oracle WebLogic Server MT (Deprecated)

View This Delivery Failure Params

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/uniformDistributedTopics/{name}/deliveryFailureParams

View this delivery failure 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 delivery failure params.

This method can return the following links:

rel=action title=findSubDeploymentName uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSSystemResources/{name}/JMSResource/uniformDistributedTopics/{name}/deliveryFailureParams/findSubDeploymentName
This resource's findSubDeploymentName action resource.
rel=errorDestination
This resource's errorDestination reference to a destination resource.
rel=templateBean
This resource's templateBean reference to a template resource.

Root Schema : Delivery Failure Params

Type: object

Show Source

errorDestination(optional): array Destination Reference

Title: Destination Reference

Contains the destination reference.
The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination.
For standalone destinations, an error destination must be another standalone destination that is targeted to the same JMS server as the destinations for which the error destination is defined. For uniform distributed destinations (UDDs), the error destination must be another UDD that shares the same subdeployment (i.e., targets) as the current UDD.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
expirationLoggingPolicy(optional): string
Default Value: oracle.doceng.json.BetterJsonNull@163d9ea1
The policy that defines what information about the message is logged when the Expiration Policy is set to Log. The valid logging policy values are:
- %header% - All JMS header fields are logged.
- %properties% - All user-defined properties are logged.
- JMSDeliveryTime - This WebLogic JMS-specific extended header field is logged.
- JMSRedeliveryLimit - This WebLogic JMS-specific extended header field is logged.
- foo - Any valid JMS header field or user-defined property is logged.
When specifying multiple values, enter them as a comma-separated list. The %header% and %properties% values are not case sensitive. For example, you could use "%header%,%properties%" for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use "%header, name, address, city, state, zip"
Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Expiration Logging Policy is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message.
expirationPolicy(optional): string
Default Value: Discard

Allowed Values: [ "Discard", "Log", "Redirect" ]
The message Expiration Policy to use when an expired message is encountered on a destination. The valid expiration policies are:
None - Same as the Discard policy; expired messages are simply removed from the destination.
Discard - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded.
Log - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy.
Redirect - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions:
- The destination for the message becomes the error destination.
- All property overrides associated with the error destination are applied to the redirected message.
- If there is no Time-To-Live Override value for the error destination, then the message receives a new Expiration Time of zero (indicating that it will not expire again).
It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy.
Note: The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy.
redeliveryLimit(optional): integer(int32)

Minimum Value: -1

Maximum Value: 2147483647

Default Value: -1

The number of redelivery tries a message can have before it is moved to the error destination. This setting overrides any redelivery limit set by the message sender. If the redelivery limit is configured, but no error destination is configured, then persistent and non-persistent messages are simply dropped (deleted) when they reach their redelivery limit.
The default value (-1) specifies that the destination will not override the message sender's redelivery limit setting.
Note: WebLogic Server supports the JMSXDeliveryCount message property, which specifies the number of message delivery attempts, where the first attempt is 1, the next attempt is 2, and so on. WebLogic Server makes a best effort to persist the delivery count, so that the delivery count does not reset back to 1 after a server reboot.
This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit.
templateBean(optional): array Template Reference

Title: Template Reference

Read Only: true

Contains the template reference.
This is used to find the template bean for this destination

{
    "type":"object",
    "properties":{
        "errorDestination":{
            "title":"Destination Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the destination reference. <p>The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination.</p><p>For standalone destinations, an error destination must be another standalone destination that is targeted to the same JMS server as the destinations for which the error destination is defined. For uniform distributed destinations (UDDs), the error destination must be another UDD that shares the same subdeployment (i.e., targets) as the current UDD.</p><p>This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.</p>"
        },
        "expirationLoggingPolicy":{
            "default":null,
            "type":"string",
            "description":"<p>The policy that defines what information about the message is logged when the Expiration Policy is set to Log. The valid logging policy values are:</p><ul><li><p><b>%header%</b> - All JMS header fields are logged.</p></li><li><p><b>%properties%</b> - All user-defined properties are logged.</p></li><li><p><b>JMSDeliveryTime</b> - This WebLogic JMS-specific extended header field is logged.</p></li><li><p><b>JMSRedeliveryLimit</b> - This WebLogic JMS-specific extended header field is logged.</p></li><li><p><b><i>foo</i></b> - Any valid JMS header field or user-defined property is logged.</p></li></ul><p>When specifying multiple values, enter them as a comma-separated list. The <code>%header%</code> and <code>%properties% </code> values are <i>not</i> case sensitive. For example, you could use <code>\"%header%,%properties%\"</code> for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use <code>\"%header, name, address, city, state, zip\"</code></p><p><b>Note:</b> The <code>JMSMessageID</code> field is always logged and cannot be turned off. Therefore, if the Expiration Logging Policy is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the <code>JMSMessageID</code> of the message. </p>"
        },
        "expirationPolicy":{
            "default":"Discard",
            "enum":[
                "Discard",
                "Log",
                "Redirect"
            ],
            "type":"string",
            "description":"<p>The message Expiration Policy to use when an expired message is encountered on a destination. The valid expiration policies are:</p><p><b>None</b> - Same as the Discard policy; expired messages are simply removed from the destination.</p><p><b>Discard</b> - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded.</p><p><b>Log</b> - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy.</p><p><b>Redirect</b> - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions:</p><ul><li><p> The destination for the message becomes the error destination.</p></li><li><p> All property overrides associated with the error destination are applied to the redirected message.</p></li><li><p> If there is no Time-To-Live Override value for the error destination, then the message receives a new Expiration Time of zero (indicating that it will not expire again).</p></li></ul><p>It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy.</p><p><b>Note:</b> The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy.</p>"
        },
        "redeliveryLimit":{
            "default":-1,
            "minimum":-1,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of redelivery tries a message can have before it is moved to the error destination. This setting overrides any redelivery limit set by the message sender. If the redelivery limit is configured, but no error destination is configured, then persistent and non-persistent messages are simply dropped (deleted) when they reach their redelivery limit.</p><p>The default value (-1) specifies that the destination will not override the message sender's redelivery limit setting. </p><p><b>Note:</b> WebLogic Server supports the JMSXDeliveryCount message property, which specifies the number of message delivery attempts, where the first attempt is 1, the next attempt is 2, and so on. WebLogic Server makes a best effort to persist the delivery count, so that the delivery count does not reset back to 1 after a server reboot.</p><p>This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit.</p>"
        },
        "templateBean":{
            "readOnly":true,
            "title":"Template Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the template reference. <p>This is used to find the template bean for this destination</p>"
        }
    },
    "description":""
}

Nested Schema : Destination Reference

Type: array

Title: Destination Reference

Contains the destination reference.

The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination.

For standalone destinations, an error destination must be another standalone destination that is targeted to the same JMS server as the destinations for which the error destination is defined. For uniform distributed destinations (UDDs), the error destination must be another UDD that shares the same subdeployment (i.e., targets) as the current UDD.

This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

Show Source

Array of: string

{
    "title":"Destination Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the destination reference. <p>The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination.</p><p>For standalone destinations, an error destination must be another standalone destination that is targeted to the same JMS server as the destinations for which the error destination is defined. For uniform distributed destinations (UDDs), the error destination must be another UDD that shares the same subdeployment (i.e., targets) as the current UDD.</p><p>This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.</p>"
}

Nested Schema : Template Reference

Type: array

Title: Template Reference

Read Only: true

Contains the template reference.

This is used to find the template bean for this destination

Show Source

Array of: string

{
    "readOnly":true,
    "title":"Template Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the template reference. <p>This is used to find the template bean for this destination</p>"
}