DistributedQueueBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

A distributed queue is one that can be load-balanced across a cluster.

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

           
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.DistributedQueueBean
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:
    Deprecated Factory Methods and Access Points


      Related MBeans

      This section describes attributes that provide access to other MBeans.


        DistributedQueueMembers

        The list of all queue members that make up the aggregate distributed queue.

        The name of the specific queue and any configuration information about that queue (such as its relative weight) can be configured in the distributed queue member.

                   
        Factory MethodscreateDistributedQueueMember (java.lang.String name)

        destroyDistributedQueueMember (DistributedDestinationMemberBean distributedDestinationMember)

        Factory methods do not return objects.

        See Using factory methods.

        Lookup OperationlookupDistributedQueueMember(String name)

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

        Privileges Read only
        TypeDistributedDestinationMemberBean[]
        Relationship type: Containment.


        Attributes

        This section describes the following attributes:


        ForwardDelay

        The number of seconds after which a distributed queue member with no consumers will wait before forwarding its messages to other distributed queue members that do have consumers.

        The default value of -1 disables this feature so that no messages are forwarded to other distributed queue members.

               
        Privileges Read/Write
        Typeint
        Default Value-1
        Secure value-1

        Id

        Return the unique identifier of this bean instance.

               
        Privileges Read only
        Typelong
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        JNDIName

        The name used to bind a virtual destination to the JNDI tree. Applications can use the JNDI name to look up the virtual destination.

        If not specified, then the destination is not bound into the JNDI namespace.

               
        Privileges Read/Write
        Typejava.lang.String

        LoadBalancingPolicy

        Determines the load balancing policy for producers sending messages to a distributed destination in order to balance the message load across the members of the distributed set.

               
        Privileges Read/Write
        Typejava.lang.String
        Default ValueRound-Robin
        Legal Values
        • Round-Robin
        • Random

        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

        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

        ResetDeliveryCountOnForward

        Determines whether or not the delivery count is reset during message forwarding between distributed queue members.

        The default value of true resets the delivery counts on messages when they are forwarded to another distributed queue member.

               
        Privileges Read/Write
        Typeboolean
        Default Valuetrue

        SAFExportPolicy

        The SAF Export Policy controls which applications can send JMS messages to this destination through Store-and-Forward.

        This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.

               
        Privileges Read/Write
        Typejava.lang.String
        Default ValueAll
        Legal Values
        • All
        • None

        UnitOfOrderRouting

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

        A WLMessageProducer with Unit of Order uses 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


        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.