DeliveryFailureParamsBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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

       
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.j2ee.descriptor.wl.DeliveryFailureParamsBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


Related MBeans

This section describes attributes that provide access to other MBeans.


    ErrorDestination

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

           
    Privileges Read/Write
    TypeDestinationBean
    Relationship type: Reference.

    TemplateBean

    This is used to find the template bean for this destination

           
    Privileges Read only
    TypeTemplateBean
    Relationship type: Reference.


    Attributes

    This section describes the following attributes:


    ExpirationLoggingPolicy

    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:

    When specifying multiple values, enter them as a comma-separated list. The %header% and %properies% 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.

    Deprecated. 9.0.0.0 Replaced by MessageLoggingParamsBean

           
    Privileges Read/Write
    Typejava.lang.String

    ExpirationPolicy

    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:

    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.

           
    Privileges Read/Write
    Typejava.lang.String
    Default ValueDiscard
    Legal Values
    • Discard
    • Log
    • Redirect

    RedeliveryLimit

    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.

           
    Privileges Read/Write
    Typeint
    Default Value-1
    Minimum value-1
    Maximum value2147483647


    Operations

    This section describes the following operations:


    findSubDeploymentName

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

       
    Operation Name"findSubDeploymentName"
    Parametersnull
    Signaturenull
    ReturnsString

    isSet

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

       
    Operation Name"isSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to check

    SignatureString [] { "java.lang.String" }
    Returns boolean
    Exceptions
    • java.lang.IllegalArgumentException
      IllegalArgumentException if propertyName is not a recognized property

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to restore

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • java.lang.IllegalArgumentException
      UnsupportedOperationException if called on a runtime implementation.