SAFImportedDestinationsBean


Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

Store-and-Forward (SAF) Imported Destinations is a collection of a SAF queues and topics that reside in a different cluster or server. These sets of SAF queues and topics refer to the same SAF Remote Context. They can also share the same JNDI prefix, Time-To-Live default, and SAF Error Handling name.

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

Factory Methods

Additional Access Points

In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:


    Child MBeans

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


    SAFErrorHandling

    Specifies the error handling used for the imported destinations.

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

    Gets the "saf-error-handling" element.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read/Write
    TypeSAFErrorHandlingBean

    SAFQueues

    Specifies an array of SAF queues defined in this SAF Imported Destinations bean.

    SAF Queue bean defines an imported JMS queue from a remote server in the local server.

               
    Factory MethodscreateSAFQueue (java.lang.String name)

    destroySAFQueue (SAFQueueBean safQueue)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupSAFQueue(String name)

    Returns a javax.management.ObjectName for the instance of SAFQueueBean named name.

    Privileges Read only
    TypeSAFQueueBean[]

    SAFRemoteContext

    Specifies the remote context used for the imported destinations.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read/Write
    TypeSAFRemoteContextBean

    SAFTopics

    Specifies an array of SAF topics defined in this SAF Imported Destinations bean.

    SAF Topic bean defines an imported JMS topic from a remote server in the local server.

               
    Factory MethodscreateSAFTopic (java.lang.String name)

    destroySAFTopic (SAFTopicBean safTopic)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupSAFTopic(String name)

    Returns a javax.management.ObjectName for the instance of SAFTopicBean named name.

    Privileges Read only
    TypeSAFTopicBean[]


    Attributes

    This section describes the following attributes:


    JNDIPrefix

    Specifies the string that will prefix the local JNDI name of a remote destination.

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

           
    Privileges Read/Write
    Typejava.lang.String

    Name

    The name of this entity, represented in XML as a 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
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    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

    SubDeploymentName

    Gets the name of the sub-deployment to use when targeting this entity

    Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    TimeToLiveDefault

    Specifies the default Time-To-Live value (expiration time), in milliseconds, for JMS messages. The expiration time set on JMS messages will override this value unless the Use SAF Time-To-Live Default option is enabled, which overrides the expiration time in JMS messages on imported destinations.

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

           
    Privileges Read/Write
    Typelong
    Default Value3600000
    Minimum value-1

    UnitOfOrderRouting

    Gets the "unit-of-order-routing" element.

    A WLMessageProducer with Unit of Order will use the "unit-of-order-routing" element rather than the "load-balancing-policy" criteria to select the Distributed Destination Member.

    Unit of Order may have been set programmatically with WLProducer, or administratively on the ConnectionFactory or Destination.



           
    Privileges Read/Write
    Typejava.lang.String
    Default ValueHash
    Legal Values
    • Hash
    • PathService
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    UseSAFTimeToLiveDefault

    Specifies whether the expiration time set on JMS messages will be overridden. If this default value is enabled, Time-To-Live Default value will override the setting on the imported destination.

           
    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

      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