JMSBean


Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

The top of the JMS module bean tree.

JMS modules all have a JMSBean as their root bean (a bean with no parent). The schema namespace that corresponds to this bean is "http://www.bea.com/ns/weblogic/90"

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

Factory Methods

No factory methods. Instances of this MBean are created automatically.

Access Points

You can 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.


    ConnectionFactories

    Gets all connection factory beans found in the JMS module

    Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.

               
    Factory MethodscreateConnectionFactory (java.lang.String name)

    destroyConnectionFactory (JMSConnectionFactoryBean connectionFactory)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupConnectionFactory(String name)

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

    Privileges Read only
    TypeJMSConnectionFactoryBean[]

    DestinationKeys

    Gets all destination key beans found in the JMS module

    Destination Key beans control the sorting criteria of JMS destinations

               
    Factory MethodscreateDestinationKey (java.lang.String name)

    destroyDestinationKey (DestinationKeyBean destinationKey)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupDestinationKey(String name)

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

    Privileges Read only
    TypeDestinationKeyBean[]

    DistributedQueues

    Gets all distributed queue beans found in the JMS module

    A distributed queue is a queue that is located on many JMS servers. Distributed queues can help with load balancing and distribution, and have many of the same properties as normal queues. Many aspects of a distributed queues behavior can be configured with a distributed queue bean.

               
    Factory MethodscreateDistributedQueue (java.lang.String name)

    destroyDistributedQueue (DistributedQueueBean distributedQueue)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupDistributedQueue(String name)

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

    Privileges Read only
    TypeDistributedQueueBean[]

    DistributedTopics

    Gets all distributed topic beans found in the JMS module

    A distributed topic is a topic that is located on many JMS servers. Distributed topics can help with load balancing and distribution, and have many of the same properties as normal topics. Many aspects of a distributed topics behavior can be configured with a distributed topic bean.

               
    Factory MethodscreateDistributedTopic (java.lang.String name)

    destroyDistributedTopic (DistributedTopicBean distributedTopic)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupDistributedTopic(String name)

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

    Privileges Read only
    TypeDistributedTopicBean[]

    ForeignServers

    Gets all foreign server beans found in the JMS module

    Foreign servers are used to configure messaging providers that are not part of the current domain. This is useful when integrating with another vendors JMS product.

               
    Factory MethodscreateForeignServer (java.lang.String name)

    destroyForeignServer (ForeignServerBean foreignServer)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupForeignServer(String name)

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

    Privileges Read only
    TypeForeignServerBean[]

    Queues

    Gets all queue beans found in the JMS module

    Queues are used for asynchronous peer communications. A message delivered to a queue will be distributed to one consumer. Several aspects of a queues behavior can be configured with a queue bean.

               
    Factory MethodscreateQueue (java.lang.String name)

    destroyQueue (QueueBean queue)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupQueue(String name)

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

    Privileges Read only
    TypeQueueBean[]

    Quotas

    Gets all quota beans found in the JMS module

    Quota beans control the allotment of system resources available to destinations. For example the number of bytes a destination is allowed to store can be configured with a QuotaBean

               
    Factory MethodscreateQuota (java.lang.String name)

    destroyQuota (QuotaBean quota)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupQuota(String name)

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

    Privileges Read only
    TypeQuotaBean[]

    SAFErrorHandlings

    Get an array of SAFErrorHandlingBean defined in this module

    SAFErrorHandlingBena defines what has to be done for messages that cannot be forwarded by SAFAgents

               
    Factory MethodscreateSAFErrorHandling (java.lang.String name)

    destroySAFErrorHandling (SAFErrorHandlingBean safErrorHandling)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupSAFErrorHandling(String name)

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

    Privileges Read only
    TypeSAFErrorHandlingBean[]

    SAFImportedDestinations

    Gets all SAFImportedDestinationsBean found in the JMS module

    SAFImportedDestinationsBean defines a set of SAFQueues and or SAFTopics imported in the local cluster from the remote Cluster or server

               
    Factory MethodscreateSAFImportedDestinations (java.lang.String name)

    destroySAFImportedDestinations (SAFImportedDestinationsBean safImportedDestinations)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupSAFImportedDestinations(String name)

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

    Privileges Read only
    TypeSAFImportedDestinationsBean[]

    SAFRemoteContexts

    Get an array of SAFRemoteContextBean for this JMS module

    SAFRemoteContextBean defines the parameters to be used by the JMS Imported Destinations (SAFQueue or SAFTopic) to connect ot the remote Cluster.

               
    Factory MethodscreateSAFRemoteContext (java.lang.String name)

    destroySAFRemoteContext (SAFRemoteContextBean safRemoteContext)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupSAFRemoteContext(String name)

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

    Privileges Read only
    TypeSAFRemoteContextBean[]

    Templates

    Gets all template beans found in the JMS module

    Template beans contain default values for destination attributes. If a destination defines a template and does not explicitly set the value of an attribute, then that attribute will take its value from the defined template.

               
    Factory MethodscreateTemplate (java.lang.String name)

    destroyTemplate (TemplateBean template)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupTemplate(String name)

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

    Privileges Read only
    TypeTemplateBean[]

    Topics

    Gets all topic beans found in the JMS module

    Topics are used for asynchronous peer communications. A message delivered to a topic will be distributed to all topic consumers. Several aspects of a topics behavior can be configured with a topic bean.

               
    Factory MethodscreateTopic (java.lang.String name)

    destroyTopic (TopicBean topic)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupTopic(String name)

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

    Privileges Read only
    TypeTopicBean[]

    UniformDistributedQueues

    Gets the uniform distributed queue beans in this JMS module

    A uniform distributed queue is a distributed queue whose members are configured as part of the configuration of the distributed queue. These members are, therefore, uniform and are created based on the targeting of the uniform distributed queue.

               
    Factory MethodscreateUniformDistributedQueue (java.lang.String name)

    destroyUniformDistributedQueue (UniformDistributedQueueBean uniformDistributedQueue)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupUniformDistributedQueue(String name)

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

    Privileges Read only
    TypeUniformDistributedQueueBean[]

    UniformDistributedTopics

    Gets all the uniform distributed topic beans in this JMS module

    A uniform distributed topic is a distributed topic whose members are configured as part of the configuration of the distributed topic. These members are, therefore, uniform and are created based on the targeting of the uniform distributed topic.

               
    Factory MethodscreateUniformDistributedTopic (java.lang.String name)

    destroyUniformDistributedTopic (UniformDistributedTopicBean uniformDistributedTopic)

    Factory methods do not return objects.

    See Using factory methods.

    Lookup OperationlookupUniformDistributedTopic(String name)

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

    Privileges Read only
    TypeUniformDistributedTopicBean[]


    Attributes

    This section describes the following attributes:


      Notes

      Optional information that you can include to describe this JMS module.

      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

      Version

      The version of this file.

             
      Privileges Read/Write
      Typeint
      Default Value1
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


      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

      lookupQueue

      Locates a queue bean with the given name

      Queues are used for asynchronous peer communications. A message delivered to a queue will be distributed to one consumer. Several aspects of a queues behavior can be configured with a queue bean.

         
      Operation Name"lookupQueue"
      ParametersObject [] {  name }

      where:

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

        The name of the queue to lookup

      SignatureString [] { "java.lang.String" }
      ReturnsQueueBean

      lookupTopic

      Locates a topic bean with the given name

         
      Operation Name"lookupTopic"
      ParametersObject [] {  name }

      where:

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

        The name of the topic to lookup

      SignatureString [] { "java.lang.String" }
      ReturnsTopicBean

      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