DistributedTopicBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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

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


     

    DistributedTopicMembers

    Gets array of all distributed-topic-member elements

    Distributed topic members are configuration information about the particular specific topics that make up the aggregate distributed topic. The name of the specific topic and any configuration information about that topic can be configured with a distributed topic member bean

    Factory Methods createDistributedTopicMember (java.lang.String name)

    destroyDistributedTopicMember (DistributedDestinationMemberBean distributedDestinationMember)

    Factory methods do not return objects.

    See Using factory methods.    

    Lookup Operation lookupDistributedTopicMember(String name)

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

    Privileges Read only    
    Type DistributedDestinationMemberBean[]
    Relationship type: Containment.


    Attributes

    This section describes the following attributes:


     

    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    
    Type java.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    
    Type java.lang.String
    Default Value Round-Robin
    Legal Values

    • Round-Robin

    • Random

     

    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

     

    SAFExportPolicy

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

    • All

      - This destination allows everyone to send JMS messages to it through SAF.

    • None

      - This destination dees not allow anyone to send JMS messages from a remote server to it through SAF.

    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    
    Type java.lang.String
    Default Value All
    Legal Values

    • All

    • None

     

    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.

    • Hash

      - producers will compute the Distributed Destination Member from the hash code of the Unit of Order.

    • PathService

      - the configured Path Service will determine the Distributed Destination Member.



       
    Privileges Read/Write    
    Type java.lang.String
    Default Value Hash
    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"    
      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.