weblogic.j2ee.descriptor.wl
Interface DeliveryFailureParamsBean

All Superinterfaces:

SettableBean

public interface DeliveryFailureParamsBean
extends SettableBean

These parameters control what should happen to messages when failures occur. They allow the adminstrator to control error destinations, logging and other actions that might be taken when a message can not be delivered or when other failures are detected

Access limited to the following security roles:

Deployer

getErrorDestination

DestinationBean getErrorDestination()

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.

Returns:

The error destination

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setErrorDestination

void setErrorDestination(DestinationBean errorDestination)
                         throws IllegalArgumentException

Sets the value of the ErrorDestination attribute.

Parameters:

errorDestination - The error destination, or null if there should be no error destination

Throws:

IllegalArgumentException

See Also:

DeliveryFailureParamsBean.getErrorDestination()

Changes take effect after you redeploy the module or restart the server.

getRedeliveryLimit

int getRedeliveryLimit()

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.

Returns:

The redelivery limit for this destination

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

setRedeliveryLimit

void setRedeliveryLimit(int redeliveryLimit)
                        throws IllegalArgumentException

Sets the value of the RedeliveryLimit attribute.

Parameters:

redeliveryLimit - The redelivery limit for this destination or -1 if there should be no redelivery limit for this destination

Throws:

IllegalArgumentException

See Also:

DeliveryFailureParamsBean.getRedeliveryLimit()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

-1

getExpirationPolicy

String getExpirationPolicy()

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.

Returns:

The expiration policy currently in use by this destination

Changes take effect after you redeploy the module or restart the server.

Default Value:

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

setExpirationPolicy

void setExpirationPolicy(String expirationPolicy)
                         throws IllegalArgumentException

Sets the value of the ExpirationPolicy attribute.

Parameters:

expirationPolicy - The expiration policy to use with this destination

Throws:

IllegalArgumentException

See Also:

DeliveryFailureParamsBean.getExpirationPolicy()

Changes take effect after you redeploy the module or restart the server.

Valid Values:

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

getExpirationLoggingPolicy

String getExpirationLoggingPolicy()

Deprecated. 9.0.0.0 Replaced by MessageLoggingParamsBean

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.

Returns:

The expiration logging policy currently in use by this destination

Changes take effect after you redeploy the module or restart the server.

Default Value:

null

setExpirationLoggingPolicy

void setExpirationLoggingPolicy(String expirationLoggingPolicy)
                                throws IllegalArgumentException

Deprecated. 9.0.0.0 Replaced by MessageLoggingParamsBean

Sets the value of the ExpirationLoggingPolicy attribute.

Parameters:

expirationLoggingPolicy - The expiration logging policy to use with this destination

Throws:

IllegalArgumentException

See Also:

DeliveryFailureParamsBean.getExpirationLoggingPolicy()

Changes take effect after you redeploy the module or restart the server.

getTemplateBean

TemplateBean getTemplateBean()

This is used to find the template bean for this destination

Returns:

The template bean that will be used for this destination, or null if this threshold bean is from a template or a template could not be found for this destination

findSubDeploymentName

String findSubDeploymentName()

This is used to find the sub-deployment-name for this destination.

Returns:

The name of the subDeployment bean that will be used for this destination, or null if this failure bean is from a template or a template could not be found for this destination