JMSSessionPoolMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class represents a JMS session pool, a server-managed pool of server sessions that enables an application to process messages concurrently.

Deprecated. 9.0.0.0 Replaced with message-dirven beans. This functionality will be removed in a future release.

       
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.JMSSessionPoolMBean
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:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


      ConnectionConsumers

      The connection consumers for this JMS session pool. JMS connection consumers are queues (Point-To-Point) or topics (Pub/Sub) that retrieve server sessions and process messages. Once you have defined a session pool, you can configure one or more connection consumers for each session pool. This method is provided for backward compatibility.

      Deprecated. 9.0.0.0 Replaced with message-driven beans.

                 
      Lookup OperationlookupJMSConnectionConsumer(String name)

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

      Privileges Read/Write
      TypeJMSConnectionConsumerMBean[]
      Relationship type: Reference.
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      JMSConnectionConsumers

      The connection consumers for this JMS session pool. JMS connection consumers are queues (Point-To-Point) or topics (Pub/Sub) that retrieve server sessions and process messages. Once you have defined a session pool, you can configure one or more connection consumers for each session pool.

                 
      Factory MethodscreateJMSConnectionConsumer (java.lang.String name)

      destroyJMSConnectionConsumer (String  connectionConsumer)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupJMSConnectionConsumer(String name)

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

      Privileges Read only
      TypeJMSConnectionConsumerMBean[]
      Relationship type: Containment.


      Attributes

      This section describes the following attributes:


      AcknowledgeMode

      The acknowledge mode used by non-transacted sessions within this JMS session pool.

      For transacted sessions, messages are acknowledged automatically when the session is committed and this value is ignored.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueAuto
      Legal Values
      • Auto
      • Client
      • Dups-Ok
      • None

      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.

      ConnectionFactory

      The JNDI name of the connection factory for this JMS session pool. Connection factories are used to create connections with predefined attributes.

             
      Privileges Read/Write
      Typejava.lang.String

      DynamicallyCreated

      Return whether the MBean was created dynamically or is persisted to config.xml

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

      Id

      Return the unique id of this MBean instance

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

      ListenerClass

      The name of the server-side listener class for this JMS session pool, which is used to receive and process messages concurrently.

             
      Privileges Read/Write
      Typejava.lang.String

      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 Server 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
      Security rolesWrite access is granted only to the following roles:
      • Deployer
      • Operator
      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 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.

      SessionsMaximum

      The maximum number of sessions allowed for this JMS session pool. A value of -1 indicates that there is no maximum.

      This attribute is dynamically configurable; however, it does not take effect until the session pool is restarted.

             
      Privileges Read/Write
      Typeint
      Default Value-1
      Minimum value-1
      Maximum value2147483647

      Tags

      Return all tags on this Configuration MBean

             
      Available Since Release 12.2.1.0.0
      Privileges Read/Write
      Typeclass java.lang.String[]

      Transacted

      Indicates whether this JMS session pool creates transacted sessions.

             
      Privileges Read/Write
      Typeboolean

      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:


      addConnectionConsumer

      Add a connection consumer to the session pool. This method is provided for backward compatibility.

      Deprecated. 9.0.0.0 Replaced with message-driven beans.

         
      Operation Name"addConnectionConsumer"
      ParametersObject [] {  connectionConsumer }

      where:

      • connectionConsumer is an object of type weblogic.management.configuration.JMSConnectionConsumerMBean that specifies:

        the connection consumer to add

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

      addTag

      Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

         
      Operation Name"addTag"
      ParametersObject [] {  tag }

      where:

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

        tag to be added to the MBean

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      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

      getInheritedProperties

      Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

         
      Operation Name"getInheritedProperties"
      ParametersObject [] {  propertyNames }

      where:

      • propertyNames is an object of type [Ljava.lang.String; that specifies:

        properties to check

      SignatureString [] { "[Ljava.lang.String;" }
      Returns class

      isInherited

      Check if the value of a property is inherited from template mbean or not.

         
      Operation Name"isInherited"
      ParametersObject [] {  propertyName }

      where:

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

        the name of the property

      SignatureString [] { "java.lang.String" }
      Returns boolean

      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

      removeConnectionConsumer

      Remove a connection consumer from the session pool. This method is provided for backward compatibility.

      Deprecated. 9.0.0.0 Replaced with message-driven beans.

         
      Operation Name"removeConnectionConsumer"
      ParametersObject [] {  connectionConsumer }

      where:

      • connectionConsumer is an object of type weblogic.management.configuration.JMSConnectionConsumerMBean that specifies:

        a reference to JMSConnectionConsumerMBean

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

      removeTag

      Remove a tag from this Configuration MBean

         
      Operation Name"removeTag"
      ParametersObject [] {  tag }

      where:

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

        tag to be removed from the MBean

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      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