SAFDestinationBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Store-and-Forward (SAF) destinations are used for asynchronous and disconnected peer communications. A message delivered to a SAF queue or a SAF topic will be forwarded to a queue or a topic in a remote cluster or server. Aspects of a SAF queues and topics behavior can be configured with a SAF queue or topic bean.

       
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.SAFDestinationBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Subtypes The following MBeans extend or implement this MBean type:


    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.


      MessageLoggingParams

      These parameters control how the SAF destination performs message logging.

      They allow the adminstrator to configure the SAF destination to change message logging when message life cycle changes are detected.

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeMessageLoggingParamsBean
      Relationship type: Containment.

      SAFErrorHandling

      Specifies the error handling configuration used by this SAF destination.

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

             
      Privileges Read/Write
      TypeSAFErrorHandlingBean
      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:


      LocalJNDIName

      The local JNDI name of the remote destination.

             
      Privileges Read/Write
      Typejava.lang.String

      Name

      The name of this 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
      Typejava.lang.String

      NonPersistentQos

      Specifies the quality-of-service for non-persistent messages.

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

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueAt-Least-Once
      Legal Values
      • At-Most-Once
      • At-Least-Once
      • Exactly-Once

      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

      RemoteJNDIName

      The remote JNDI name of the remote destination.

             
      Privileges Read/Write
      Typejava.lang.String

      TimeToLiveDefault

      Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations.

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

             
      Privileges Read/Write
      Typelong
      Minimum value-1

      UnitOfOrderRouting

      Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.

             
      Privileges Read/Write
      Typejava.lang.String
      Legal Values
      • Hash
      • PathService

      UseSAFTimeToLiveDefault

      Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.

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

             
      Privileges Read/Write
      Typeboolean


      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.