SAFErrorHandlingBean

Overview  |   Related MBeans  |   Attributes  |   Operations

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.

Security roles The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:

  • Deployer
   
Fully Qualified Interface Name If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.j2ee.descriptor.wl.SAFErrorHandlingBean
   
Factory Methods No factory methods. Instances of this MBean are created automatically.

Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

     

    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.

       
    Privileges Read/Write    
    Type SAFDestinationBean
    Relationship type: Reference.
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Attributes

    This section describes the following attributes:

     

    LogFormat

    Specifies how information is logged when Policy is set to Log.

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

       
    Privileges Read/Write    
    Type java.lang.String

     

    Name of

    Name of 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.

       
    Privileges Read/Write    
    Type java.lang.String

     

    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 &lt;. 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.

       
    Privileges Read/Write    
    Type java.lang.String

     

    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.

       
    Privileges Read/Write    
    Type java.lang.String
    Default Value Discard
    Legal Values

    • Discard

    • Log

    • Redirect

    • Always-Forward

    Operations

    This section describes the following operations:

       

      isSet

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

      Operation Name "isSet"    
      Parameters Object [] {  propertyName }

      where:

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

        property to check

      Signature String [] { "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"    
      Parameters Object [] {  propertyName }

      where:

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

        property to restore

      Signature String [] { "java.lang.String" }
      Returns void
      Exceptions

      • java.lang.IllegalArgumentException
        UnsupportedOperationException if called on a runtime implementation.