Package weblogic.j2ee.descriptor.wl

Interface SAFErrorHandlingBean

All Superinterfaces:

NamedEntityBean, SettableBean

public interface SAFErrorHandlingBean
extends NamedEntityBean

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.

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method	Description
java.lang.String	getLogFormat()	Specifies how information is logged when Message Handling Policy is set to Log.
java.lang.String	getPolicy()	The error handling policy for this SAF error handling resource.
SAFDestinationBean	getSAFErrorDestination()	Specifies the error destination when Policy is set to Redirect.
void	setLogFormat(java.lang.String logFormat)	Sets the value of the LogFormat attribute.
void	setPolicy(java.lang.String policy)	Sets the value of the Policy attrubute.
void	setSAFErrorDestination(SAFDestinationBean errorDestination)	Sets the value of the SAFErrorDestination attribute.

Methods inherited from interface weblogic.j2ee.descriptor.wl.NamedEntityBean

getId, getName, getNotes, setName, setNotes

Method Detail

getPolicy

java.lang.String getPolicy()

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.

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.DISCARD

setPolicy

void setPolicy(java.lang.String policy)
        throws java.lang.IllegalArgumentException

Sets the value of the Policy attrubute.

Throws:

java.lang.IllegalArgumentException

See Also:

getPolicy()

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.DISCARD

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

This property cannot be null.

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.DISCARD,weblogic.j2ee.descriptor.wl.constants.JMSConstants.LOGGING,weblogic.j2ee.descriptor.wl.constants.JMSConstants.ERRORDESTINATION,weblogic.j2ee.descriptor.wl.constants.JMSConstants.ALWAYSFORWARD

getLogFormat

java.lang.String getLogFormat()

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.

setLogFormat

void setLogFormat(java.lang.String logFormat)
           throws java.lang.IllegalArgumentException

Sets the value of the LogFormat attribute.

Throws:

java.lang.IllegalArgumentException

See Also:

getLogFormat()

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

getSAFErrorDestination

SAFDestinationBean getSAFErrorDestination()

Specifies the error destination when Policy is set to Redirect.

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

setSAFErrorDestination

void setSAFErrorDestination(SAFDestinationBean errorDestination)
                     throws java.lang.IllegalArgumentException

Sets the value of the SAFErrorDestination attribute.

Throws:

java.lang.IllegalArgumentException