DefaultSAFAgentBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class represents a Store-and-Forward (SAF) agent. A SAF sending agent takes care of storing messages to a persistent storage, forwarding messages to the receiving side, and re-transmitting messages when acknowledgements do not come back in time. A SAF receiving agent takes care of detecting and eliminating duplicate messages sent by the receiving agent, and deliver messages to the final endpoint.

       
Since9.0.2.0
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.DefaultSAFAgentBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Attributes

    This section describes the following attributes:


    BytesMaximum

    The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.

    Range of Values: >= BytesThresholdHigh

           
    Privileges Read/Write
    Typelong
    Default Value-1
    Minimum value-1

    DefaultRetryDelayBase

    The amount of time, in milliseconds, between the original delivery attempt and the first retry.

    Range of Values: <= RetryDelayMaximum if RetryDelayMultiplier is not 1.0.

           
    Privileges Read/Write
    Typelong
    Default Value20000
    Minimum value1

    DefaultRetryDelayMaximum

    The maximum amount of time, in milliseconds, between two successive delivery retry attempts.

    Range of Values: > = RetryDelayBase if RetryDelayMultiplier is not 1.0.

           
    Privileges Read/Write
    Typelong
    Default Value180000
    Minimum value1

    DefaultRetryDelayMultiplier

    The factor used to multiply the previous delay time to calculate the next delay time to be used.

    Range of Values: >= 1.

           
    Privileges Read/Write
    Typedouble
    Default Value1.0
    Minimum value1.0

    DefaultTimeToLive

    The default amount of time, in milliseconds, that the agent guarantees to reliably send messages.

           
    Privileges Read/Write
    Typelong
    Default Value0
    Minimum value0

    LoggingEnabled

    Specifies whether a message is logged in the server log file when a message fails to be forwarded.

    Deprecated. since WebLogic 9.0.1 release

           
    Privileges Read/Write
    Typeboolean
    Default Valuetrue

    MaximumMessageSize

    The maximum number of bytes allowed in individual messages on this SAF agent.

           
    Privileges Read/Write
    Typeint
    Default Value2147483647
    Minimum value0

    MessageBufferSize

    The amount of memory used to store message bodies in memory before they are paged out to disk.

    For more information, see:

           
    Privileges Read/Write
    Typelong
    Default Value-1
    Minimum value-1

    MessagesMaximum

    The maximum message quota (total amount of messages) that can be stored in this SAF agent.

    Range of Values: >= MessagesThresholdHigh

           
    Privileges Read/Write
    Typelong
    Default Value-1
    Minimum value-1

    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
    Typejava.lang.String

    PagingDirectory

    Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size. If unspecified, messages are written to the tmp directory in the host WebLogic Server instance's directory. For example, domainName/servers/servername/tmp.

    For more information, see:

           
    Privileges Read/Write
    Typejava.lang.String

    WindowInterval

           
    Privileges Read/Write
    Typelong
    Default Value0
    Minimum value0

    WindowSize

    The default window size of a SAF agent.

    Updating WindowSize causes connections starting after the update to use the new value.

           
    Privileges Read/Write
    Typeint
    Default Value10
    Minimum value1


    Operations

    This section describes the following operations:


      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.