Jump to

• Request
• Response

View This SAF Error Handling

get

/management/weblogic/{version}/edit/resourceGroupTemplates/{name}/JMSSystemResources/{name}/JMSResource/SAFErrorHandlings/{name}

View this SAF error handling.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this SAF error handling.

This method can return the following links:

• rel=SAFErrorDestination

  This resource's SAFErrorDestination reference to a SAF destination resource.

Body ()

Root Schema : SAF Error Handling

Type: object

Show Source

• id(optional): integer(int64)
  Read Only: true

  Return the unique identifier of this bean instance.

• logFormat(optional): string

  Specifies how information is logged when Message Handling Policy is set to Log

  Any change to this parameter affects only incoming messages; stored messages are not affected.

  The valid 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 Log Format 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.

• 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.

• policy(optional): string
  Default Value: Discard

  Allowed Values: [ "Discard", "Log", "Redirect", "Always-Forward" ]

  The error handling policy for this SAF error handling resource.

  • Discard - By default, expired messages are simply removed from the system. The removal is not logged and the message is not redirected to another location.

  • Log - Removes expired messages and writes an entry to the server log file indicating that the messages were removed from the system. You define the actual information that will be logged in the Log Format field.

  • Redirect - Moves expired messages from their current location into the Error Destination defined for imported SAF destinations.

  • Always-Forward - Ignores the SAF Default Time-to-Live value set on the imported destination and the expiration time set on the message, and so forwards the message to a remote destination even after it has expired.

  Any change to this parameter affects only incoming messages; stored messages are not affected.

  Constraints

  • legal null
• SAFErrorDestination(optional): array SAF Destination Reference
  Title: SAF Destination Reference

  Contains the SAF destination reference.

  Specifies the error destination when Policy is set to Redirect

  Any change to this parameter affects only incoming messages; stored messages are not affected.

  Constraints

  • restart required

{
    "type":"object",
    "properties":{
        "SAFErrorDestination":{
            "x-weblogic-restartRequired":true,
            "title":"SAF Destination Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the SAF destination reference. <p>Specifies the error destination when <code>Policy</code> is set to <code>Redirect</code></p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique identifier of this bean instance.</p>"
        },
        "logFormat":{
            "type":"string",
            "description":"<p>Specifies how information is logged when <code>Message Handling Policy</code> is set to <code>Log</code></p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p>The valid 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 Log Format 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>"
        },
        "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>"
        },
        "policy":{
            "default":"Discard",
            "enum":[
                "Discard",
                "Log",
                "Redirect",
                "Always-Forward"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The error handling policy for this SAF error handling resource.</p><ul><li><p> Discard - By default, expired messages are simply removed from the system. The removal is not logged and the message is not redirected to another location.</p></li><li><p> Log - Removes expired messages and writes an entry to the server log file indicating that the messages were removed from the system. You define the actual information that will be logged in the Log Format field.</p></li><li><p> Redirect - Moves expired messages from their current location into the Error Destination defined for imported SAF destinations.</p></li><li><p> Always-Forward - Ignores the SAF Default Time-to-Live value set on the imported destination and the expiration time set on the message, and so forwards the message to a remote destination even after it has expired.</p></li></ul><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        }
    },
    "description":""
}

Nested Schema : SAF Destination Reference

Type: array

Title: SAF Destination Reference

Contains the SAF destination reference.

Specifies the error destination when Policy is set to Redirect

Any change to this parameter affects only incoming messages; stored messages are not affected.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"SAF Destination Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the SAF destination reference. <p>Specifies the error destination when <code>Policy</code> is set to <code>Redirect</code></p><p>Any change to this parameter affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Back to Top