SAFErrorHandlingBean

Overview

Store-and-Forward (SAF) Error Handling defines the action to be taken when the delivery of a JMS message fails to be forwarded to a remote destination.

Related MBeans

This section describes attributes that provide access to other MBeans.

SAFErrorDestination

Specifies the error destination when Policy is set to Redirect.

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

Attributes

This section describes the following attributes:

Id

Return the unique identifier of this bean instance.

LogFormat

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

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.

Notes

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

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.

Operations

This section describes the following operations:

isSet

Return true if the given property has been explicitly set in this bean.

unSet

Restore the given property to its default value.