JMSServerMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class represents a JMS server. A JMS server manages connections and message requests on behalf of clients.

           
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.JMSServerMBean
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:
    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:
      Access Points Inherited from TargetMBean Because this MBean extends or implements TargetMBean, you can also access this MBean by retrieving TargetMBeans. The following attributes contain TargetMBeans and its subtypes:
      Deprecated Factory Methods and Access Points


      Related MBeans

      This section describes attributes that provide access to other MBeans.


      Destinations

      All defined destinations and their associated JNDI names.

      Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

             
      Privileges Read only
      TypeJMSDestinationMBean[]
      Relationship type: Reference.

      JMSMessageLogFile

      The message log file configuration for this JMS Server.

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeJMSMessageLogFileMBean
      Relationship type: Containment.

      JMSQueues

      Acquire JMSQueues for this JMSServer

      Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

                 
      Factory MethodscreateJMSQueue (java.lang.String name)

      destroyJMSQueue (JMSQueueMBean queue)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupJMSQueue(String name)

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

      Privileges Read only
      TypeJMSQueueMBean[]
      Relationship type: Containment.

      JMSSessionPools

      The session pools defined for the JMS server.

      Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

                 
      Factory MethodscreateJMSSessionPool (java.lang.String name)

      destroyJMSSessionPool (JMSSessionPoolMBean sessionPool)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupJMSSessionPool(String name)

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

      Privileges Read only
      TypeJMSSessionPoolMBean[]
      Relationship type: Containment.

      JMSTopics

      Define JMSTopics for this Domain

      Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

                 
      Factory MethodscreateJMSTopic (java.lang.String name)

      destroyJMSTopic (JMSTopicMBean topic)

      Factory methods do not return objects.

      See Using factory methods.

      Lookup OperationlookupJMSTopic(String name)

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

      Privileges Read only
      TypeJMSTopicMBean[]
      Relationship type: Containment.

      PagingStore

      This parameter has been deprecated. New configurations should use the "PagingDirectory" parameter if they wish to control where non-persistent messages will be temporarily stored.

      Deprecated. 9.0.0.0 Replaced with the PagingDirectory attribute.

      For more information, see:

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

      PersistentStore

      The file or database in which this JMS server stores persistent messages. If unspecified, the JMS server uses the default persistent store that is configured on each targeted WebLogic Server instance. If the JMS server has a store configured, then the configured store is used to store persistent messages.

      The disk-based file store or JDBC-accessible database store that you specify must be targeted to the same server, cluster, or migratable target instance as this JMS server. Multiple services on the same WebLogic Server instance, including multiple JMS servers, may share the same persistent store. Each service's persistent data will be kept apart.

      If you specify a PersistentStore, the deprecated Store field must not be set. If neither the PersistentStore field nor the Store field are set, the JMS server supports persistent messaging using the default persistent store for the targeted WebLogic Server instance.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

      For more information, see:

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

      SessionPools

      The session pools defined for the JMS server. This method is provided for backward compatibility.

      Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

                 
      Lookup OperationlookupJMSSessionPool(String name)

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

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

      Store

      The persistent disk-based file or JDBC-accessible database for the JMS server.

      A persistent store may only be used by one JMS server. If this value is unset, the value set by the "PersistentStore" attribute is used. If neither attribute is set, the default persistent store for the targeted managed server is used. It is an error to set both attributes.

      This attribute has been deprecated. New configurations should use the "PersistentStore" attribute, which allows multiple subsystems, including multiple JMS servers on the same managed server, to share the same persistent store.

      Deprecated. 9.0.0.0 Replaced with the PersistentStore attribute.

      For more information, see:

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

      Targets

      The server instances, clusters, or a migratable targets defined in the current domain that are candidates for hosting the JMSSerer.

      In a clustered environment, a recommended best practice is to use a cluster as a target or target a JMSServer to the same migratable target as the Persistent Store that it uses, so that a member server will not be a single point of failure. A JMSServer can also be configured to automatically migrate from an unhealthy server instance to a healthy server instance with the help of the automatic service migration feature.

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

      TemporaryTemplate

      The name of an existing JMS template to use when creating all temporary queues and topics for this JMS server. Specifying a value for this field allows JMS applications to create temporary destinations. If Store values are provided as part of a temporary template, they are ignored, because temporary destinations do not support persistent messaging.

      Note: If this attribute is set to none, attempts to create a temporary destination (queue or topic) will fail.

      Deprecated. 9.0.0.0 Replaced with the TemporaryTemplateName and TemporaryTemplateResource attributes.

             
      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:


      AllowsPersistentDowngrade

      Specifies whether JMS clients will get an exception when sending persistent messages to a destination targeted to a JMS server that does not have a persistent store configured. This parameter only has effect when the Store Enabled parameter is disabled (false).

      When set to false, the default, clients will get an exception when sending persistent messages to a JMS server with no store configured. When set to true, then persistent messages are downgraded to non-persistent; however, the send operations are allowed to continue.

             
      Privileges Read/Write
      Typeboolean

      BlockingSendPolicy

      Determines whether the JMS server delivers smaller messages before larger ones when a destination has exceeded its maximum number of messages. FIFO prevents the JMS server from delivering smaller messages when larger ones are already waiting for space. Preemptive allows smaller send requests to preempt previous larger ones when there is sufficient space for smaller messages on the destination.

      This policy is defined only for the JMS server; it cannot be set on individual destinations.

      Additional information on the FIFO and Preemptive policies is provided below.

      FIFO (first in, first out) indicates that all send requests for the same destination are queued up one behind the other until space is available. No send request is permitted to successfully complete if there is another send request waiting for space before it. When space is limited, the FIFO policy prevents the starvation of larger requests because smaller requests cannot continuously use the remaining available space. Smaller requests are delayed, though not starved, until the larger request can be completed. When space does become available, requests are considered in the order in which they were made. If there is sufficient space for a given request, then that request is completed and the next request is considered. If there is insufficient space for a given request, then no further requests are considered until sufficient space becomes available for the current request to complete.

      Preemptive indicates that a send operation can preempt other blocking send operations if space is available. That is, if there is sufficient space for the current request, then that space is used even if there are other requests waiting for space. When space is limited, the Preemptive policy can result in the starvation of larger requests. For example, if there is insufficient available space for a large request, then it is queued up behind other existing requests. When space does become available, all requests are considered in the order in which they were originally made. If there is sufficient space for a given request, then that request is allowed to continue and the next request is considered. If there is insufficient space for a given request, then that request is skipped and the next request is considered.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueFIFO
      Legal Values
      • FIFO
      • Preemptive

      BytesMaximum

      The maximum number of bytes that can be stored in this JMS server. A value of -1 removes any WebLogic Server limits.

      Because excessive bytes volume can cause memory saturation, Oracle recommends that this maximum corresponds to the total amount of system memory available after accounting for the rest of your application load.

      Range of Values: >= BytesThresholdHigh

             
      Privileges Read/Write
      Typelong
      Default Value-1
      Minimum value-1
      Maximum value9223372036854775807

      BytesPagingEnabled

      This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.

      Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      BytesThresholdHigh

      The upper threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.

      The triggered events are:

      Range of Values: <= BytesMaximum; >= BytesThresholdLow

             
      Privileges Read/Write
      Typelong
      Default Value-1
      Minimum value-1
      Maximum value9223372036854775807

      BytesThresholdLow

      The lower threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.

      If the number of bytes falls below this threshold, the triggered events are:

      Range of Values: <= BytesThresholdHigh

             
      Privileges Read/Write
      Typelong
      Default Value-1
      Minimum value-1
      Maximum value9223372036854775807

      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.

      ConsumptionPausedAtStartup

      Indicates whether consumption is paused at startup on destinations targeted to this JMS server at startup. A destination cannot receive any new messages while it is paused.

      When the value is set to true, then immediately after the host server instance is booted, then this JMS server and its targeted destinations are modified such that they are in a "consumption paused" state, which prevents any message consuming activity on those destinations.

      To allow normal message consumption on the destinations, later you will have to change the state of this JMS server to a "consumption enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.

      When the value is set to default, then the Consumption Paused At Startup is determined based on the corresponding setting on the individual destination.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String
      Default Valuedefault

      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

      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.

      ExpirationScanInterval

      The number of seconds between this JMS server's cycles of scanning local destinations for expired messages. A value of 0 disables active scanning. A very large scan interval effectively disables active scanning.

      With scanning disabled, users still do not receive expired messages and any expired messages that are discovered by other system activities are removed. However, expired messages sitting in idle destinations (such as an inactive queue or disconnected durable subscriber) are not removed and continue to consume system resources.

      The scanning cycle for expired messages occurs as follows:

      Note: Because a new scan does not start until the current one is finished and until the specified waiting period ends, an expired message could still remain in the system for the maximum scan waiting period plus the amount of time it takes to perform the scan.

             
      Privileges Read/Write
      Typeint
      Default Value30
      Minimum value0
      Maximum value2147483647

      HostingTemporaryDestinations

      Specifies whether this JMS server can be used to host temporary destinations.

      If this field is enabled and no Temporary Template Name is defined, then the temporary destinations created on this JMS server will use all default destination values. If this field is enabled, then the JMS template to be used for creating temporary destinations is specified by the Temporary Template Name field. If this field is disabled, then this JMS server will not host temporary destinations.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      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.

      InsertionPausedAtStartup

      Indicates whether insertion is paused at startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.

      When the value is set to true, then immediately after the host server instance is booted, then this JMS server and its targeted destinations are modified such that they are in a "insertion paused" state, which results preventing messages that are result of the "in-flight" work completion to arrive on those destinations.

      Note: For a detailed definition of "in-flight" work/messages, see weblogic.management.runtime.JMSServerRuntimeMBean#resumeInsertion and weblogic.management.runtime.JMSDestinationRuntime#resumeInsertion

      To allow in-flight work messages to appear on the destinations, later you will have to change the state of this JMS server to an "insertion enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.

      When the value is set to default, then the Insertion Paused At Startup is determined based on the corresponding setting on the individual destination.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String
      Default Valuedefault

      MaximumMessageSize

      The maximum number of bytes allowed in individual messages on this JMS server. The size of a message includes the message body, any user-defined properties, and the user-defined JMS header fields JMSCorrelationID and JMSType.

      The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.

      Note: Any change to this maximum affects only incoming messages; stored messages are not affected.

             
      Privileges Read/Write
      Typeint
      Default Value2147483647
      Minimum value0
      Maximum value2147483647

      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.

      MessageBufferSize

      The amount of memory (in bytes) that this JMS server can use to store message bodies before it writes them to disk. When the JMS server writes the message bodies to disk, it clears them from memory.

      A value of -1 (the default) specifies that the server will automatically determine a size based on the maximum heap size of the JVM. This default will be set to either one-third the maximum heap size, or 512 megabytes, whichever is smaller.

      The larger the buffer, the more memory JMS will consume when many messages are waiting on queues or topics. Once the buffer is surpassed, JMS may write message bodies to the directory specified by PagingDirectory in an effort to reduce memory usage below this buffer.

      Surpassing the buffer size does not stop the JMS server from accepting new messages. It is still possible to run out of memory if messages are arriving faster than they can be written to disk. Users with high messaging loads who wish to support the highest possible availability should consider setting a quota or setting a threshold and enabling flow control.

      Paging is always supported.

      For more information, see:

             
      Privileges Read/Write
      Typelong
      Default Value-1
      Minimum value-1
      Maximum value9223372036854775807

      MessageCompressionOptions

      Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueGZIP_DEFAULT_COMPRESSION
      Legal Values
      • GZIP_DEFAULT_COMPRESSION
      • GZIP_BEST_COMPRESSION
      • GZIP_BEST_SPEED
      • LZF

      MessagesMaximum

      The maximum number of messages that can be stored in this JMS server. A value of -1 removes any WebLogic Server limits.

      Because excessive message volume can cause memory saturation, Oracle recommends that this value corresponds to the total amount of system memory available after accounting for the rest of your application load.

      Range of Values: >= MessagesThresholdHigh.

             
      Privileges Read/Write
      Typelong
      Default Value-1
      Minimum value-1
      Maximum value9223372036854775807

      MessagesPagingEnabled

      This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.

      Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      MessagesThresholdHigh

      The upper threshold (number of messages stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.

      If the number of messages exceeds this threshold, the triggered events are:

      Range of Values: <= MessagesMaximum; >= MessagesThresholdLow.

             
      Privileges Read/Write
      Typelong
      Default Value-1
      Minimum value-1
      Maximum value9223372036854775807

      MessagesThresholdLow

      The lower threshold (number of messages stored in this JMS server) that triggers flow control and logging events. A value of -1 disables the events for this JMS server.

      If the number of messages falls below this threshold, the triggered events are:

      Note: This attribute is dynamically configurable.

      Range of Values: <= MessagesThresholdHigh

             
      Privileges Read/Write
      Typelong
      Default Value-1
      Minimum value-1
      Maximum value9223372036854775807

      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.

      PagingBlockSize

      The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the paging block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].

      A paging store's block size does not change once the paging store creates its files. Changes to block size only take effect for new paging stores or after the current files have been deleted. See "Tuning the Persistent Store" in Performance and Tuning for Oracle WebLogic Server.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

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

      PagingDirectory

      Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size.

      If unspecified, messages are written to the default tmp directory inside the server-name subdirectory of a domain's root directory. For example, domain-name/servers/server-name/tmp, where domain-name is the root directory of your domain.

      For best performance, this directory should not be the same as the directory used by the JMS server's persistent store.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String

      PagingFileLockingEnabled

      Determines whether OS file locking is used.

      When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      PagingIoBufferSize

      The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

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

      PagingMaxFileSize

      The paging maximum file size, in bytes.

      Oracle recommends not setting the Paging Max File Size above the default value of 1,342,177,280.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

             
      Privileges Read/Write
      Typelong
      Default Value1342177280
      Minimum value10485760

      PagingMaxWindowBufferSize

      The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per paging store file. Applies only when a native wlfileio library is loaded.

      A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the paging store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches PagingMinWindowBufferSize, and then fails if it cannot honor PagingMinWindowBufferSize.

      Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.

      See the JMS server runtime MBean attribute PagingAllocatedWindowBufferBytes to find out the actual allocated Window Buffer Size.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

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

      PagingMessageCompressionEnabled

      Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. When false, the default value, no compression is performed.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      PagingMinWindowBufferSize

      The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per paging store file. Applies only when a native wlfileio library is loaded. See Paging Maximum Window Buffer Size.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

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

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      ProductionPausedAtStartup

      Specifies whether production is paused at server startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.

      When the value is set to true, then immediately after the host server instance is rebooted, then this JMS server and its targeted destinations are modified such that they are in a "production paused" state, which results in preventing new message production activities on those destinations.

      To resume normal new message production activity, later you will have to change the state of this JMS server to a "production enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.

      When the value is set to default, then the Production Paused At Startup is determined based on the corresponding setting on the individual destination.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String
      Default Valuedefault

      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.

      StoreEnabled

      Specifies whether message persistence is supported for this JMS server.

      Oracle recommends not setting this parameter to false. It is available to provide compatibility with older releases.

      If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      StoreMessageCompressionEnabled

      Enables the JMS store to perform message body compression. When set to false, the default value, no compression is performed.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      Tags

      Return all tags on this Configuration MBean

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

      TemporaryTemplateName

      The name of a configured JMS template that this JMS server uses to create temporary destinations.

      Entering a template name, requires you to specify the JMS module that contains this template. However, a template name cannot be specified if the Hosting Temporary Destinations field is disabled.

      Note: If the specified JMS template provides persistent store values, they are ignored because temporary destinations do not support persistent messaging.

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String

      TemporaryTemplateResource

      The name of a JMS module that contains a template that this JMS server can use to create temporary destinations.

      Entering a JMS module name requires you to specify a temporary template name. However, a module name cannot be specified if the Hosting Temporary Destinations field is disabled.

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String

      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:


      addDestination

      Add a JMS destination to the JMS server.

      Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

         
      Operation Name"addDestination"
      ParametersObject [] {  destination }

      where:

      • destination is an object of type weblogic.management.configuration.JMSDestinationMBean that specifies:

        the destination to be added to the JMS server

      SignatureString [] { "weblogic.management.configuration.JMSDestinationMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
        IllegalArgumentException if destination is null or exists
      • weblogic.management.DistributedManagementException

      addSessionPool

      Add a session pool to the JMS server. This method is provided for backward compatibility.

      Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

         
      Operation Name"addSessionPool"
      ParametersObject [] {  sessionPool }

      where:

      • sessionPool is an object of type weblogic.management.configuration.JMSSessionPoolMBean that specifies:

        the sessionPool to add to the JMS server

      SignatureString [] { "weblogic.management.configuration.JMSSessionPoolMBean" }
      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

      addTarget

      Targets the JMSServer to the specified target instance. The target must be either a server, cluster, or a migratable target.

         
      Operation Name"addTarget"
      ParametersObject [] {  target }

      where:

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

        The target where the JMSServer needs to be deployed

      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

      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

      removeDestination

      Removes a destination from the JNDI tree.

      Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

         
      Operation Name"removeDestination"
      ParametersObject [] {  destination }

      where:

      • destination is an object of type weblogic.management.configuration.JMSDestinationMBean that specifies:

        the destination to be removed from the JMS server

      SignatureString [] { "weblogic.management.configuration.JMSDestinationMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
        IllegalArgumentException if destination is null or does not exist
      • weblogic.management.DistributedManagementException

      removeSessionPool

      Remove a session pool from the JMS server. This method is provided for backward compatibility.

      Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

         
      Operation Name"removeSessionPool"
      ParametersObject [] {  sessionPool }

      where:

      • sessionPool is an object of type weblogic.management.configuration.JMSSessionPoolMBean that specifies:

        the sessionPool to remove from the JMS server

      SignatureString [] { "weblogic.management.configuration.JMSSessionPoolMBean" }
      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

      removeTarget

      Untargets the JMSServer instance from the current target.

      For more information, see:

         
      Operation Name"removeTarget"
      ParametersObject [] {  target }

      where:

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

        The target that has to be removed from the JMSServer

      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

      setDestinations

      Sets the value of the Destinations attribute.

      Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

      For more information, see:

         
      Operation Name"setDestinations"
      ParametersObject [] {  destinations }

      where:

      • destinations is an object of type [Lweblogic.management.configuration.JMSDestinationMBean; that specifies:

        The new destinations value

      SignatureString [] { "[Lweblogic.management.configuration.JMSDestinationMBean;" }
      Returns void
      Exceptions
      • javax.management.InvalidAttributeValueException

      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