JMSDistributedTopicMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class represents a JMS distributed topic, which is comprised of multiple physical JMS topics as members of a single distributed set of topics that can be served by multiple WebLogic Server instances within a cluster.

Deprecated. 9.0.0.0 Replaced by DistributedTopicBean

               
Since7.0.0.0
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.management.configuration.JMSDistributedTopicMBean

For more information, see:

Factory Methods
Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:
    Deprecated Factory Methods and Access Points


      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.


      JMSDistributedTopicMembers

      Get all the Members

                 
      Factory MethodscreateJMSDistributedTopicMember (java.lang.String name)

      destroyJMSDistributedTopicMember (String  name)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupJMSDistributedTopicMember(String name)

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

      Privileges Read only
      TypeJMSDistributedTopicMemberMBean[]
      Relationship type: Containment.

      Members

      The members for this distributed topic.

                 
      Lookup OperationlookupJMSDistributedTopicMember(String name)

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

      Privileges Read/Write
      TypeJMSDistributedTopicMemberMBean[]
      Relationship type: Reference.

      Targets

      You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

             
      Privileges Read/Write
      TypeTargetMBean[]
      Relationship type: Reference.

      Template

      The JMS template from which the distributed destination is derived.

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


      CachingDisabled

      Private property that disables caching in proxies.

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

      DeploymentOrder

      A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

      For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

      Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

             
      Privileges Read/Write
      Typeint
      Default Value1000
      Minimum value0
      Maximum value2147483647

      JNDIName

      The JNDI name used to look up a virtual destination within the JNDI namespace. 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

      Defines 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

      MBeanInfo

      Returns the MBean info for this MBean.

      Deprecated.

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

      Name

      The user-specified name of this MBean instance.

      This name is included as one of the key properties in the MBean's javax.management.ObjectName:
      Name=user-specified-name

             
      Privileges Read/Write
      Typejava.lang.String

      Notes

      Optional information that you can include to describe this configuration.

      WebLogic Sever saves this note in the domain's configuration file (config.xml) 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

      ObjectName

      Returns the ObjectName under which this MBean is registered in the MBean server.

      Deprecated.

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

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      Registered

      Returns false if the the MBean represented by this object has been unregistered.

      Deprecated.

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

      Type

      Returns the type of the MBean.

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


      Operations

      This section describes the following operations:


      addMember

      Add a member to this distributed topic.

         
      Operation Name"addMember"
      ParametersObject [] {  Member }

      where:

      • Member is an object of type weblogic.management.configuration.JMSDistributedTopicMemberMBean that specifies:

        The feature to be added to the Member attribute

      SignatureString [] { "weblogic.management.configuration.JMSDistributedTopicMemberMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      addTarget

      You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

         
      Operation Name"addTarget"
      ParametersObject [] {  target }

      where:

      • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

        The feature to be added to the Target attribute

      SignatureString [] { "weblogic.management.configuration.TargetMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      freezeCurrentValue

      If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

      Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

      Note:

      To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

      Deprecated. 9.0.0.0

         
      Operation Name"freezeCurrentValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException
      • javax.management.MBeanException

      isSet

      Returns true if the specified attribute has been set explicitly in this MBean instance.

         
      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

      removeMember

      Remove a member from this distributed topic.

         
      Operation Name"removeMember"
      ParametersObject [] {  member }

      where:

      • member is an object of type weblogic.management.configuration.JMSDistributedTopicMemberMBean that specifies:

        the JMSDistributedTopicMember to remove from the distributed topic

      SignatureString [] { "weblogic.management.configuration.JMSDistributedTopicMemberMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
        IllegalArgumentException if the specified member is not a member of this distributed topic
      • weblogic.management.DistributedManagementException

      removeTarget

      Removes the value of the addTarget attribute.

      For more information, see:

         
      Operation Name"removeTarget"
      ParametersObject [] {  target }

      where:

      • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

        target

      SignatureString [] { "weblogic.management.configuration.TargetMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      restoreDefaultValue

      If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

      Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

      Deprecated. 9.0.0.0

         
      Operation Name"restoreDefaultValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException

      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