JMSServerRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class is used for monitoring a WebLogic JMS server.

   
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.runtime.JMSServerRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
    Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


    Destinations

    An array of destinations on this JMS server.

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

    LogRuntime

    Gets the log runtime instance for this JMSServerRuntime.

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

    SessionPoolRuntimes

    The session pools running on this JMS server.

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


    Attributes

    This section describes the following attributes:


    BytesCurrentCount

    The current number of bytes stored on this JMS server.

    This number does not include the pending bytes.

           
    Privileges Read only
    Typelong

    BytesHighCount

    The peak number of bytes stored in the JMS server since the last reset.

           
    Privileges Read only
    Typelong

    BytesPageableCurrentCount

    Return the total number of bytes in all the messages that are currently available to be paged out, but which have not yet been paged out. The JMS server attempts to keep this number smaller than the "MessageBufferSize" parameter.

           
    Privileges Read only
    Typelong

    BytesPagedInTotalCount

    Return the total number of bytes that were read from the paging directory since the JMS server was started.

           
    Privileges Read only
    Typelong

    BytesPagedOutTotalCount

    Return the total number of bytes that were written to the paging directory since the JMS server was started.

           
    Privileges Read only
    Typelong

    BytesPendingCount

    The current number of bytes pending (unacknowledged or uncommitted) stored on this JMS server.

    Pending bytes are over and above the current number of bytes.

           
    Privileges Read only
    Typelong

    BytesReceivedCount

    The number of bytes received on this JMS server since the last reset.

           
    Privileges Read only
    Typelong

    BytesThresholdTime

    The amount of time in the threshold condition since the last reset.

           
    Privileges Read only
    Typelong

    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean

    ConsumptionPaused

    Returns the current consumption paused state of the JMSServer as boolean value.

           
    Privileges Read only
    Typeboolean

    ConsumptionPausedState

    Returns the current consumption paused state of the JMSServer as string value.

           
    Privileges Read only
    Typejava.lang.String

    DestinationsCurrentCount

    The current number of destinations for this JMS server.

           
    Privileges Read only
    Typelong

    DestinationsHighCount

    The peak number of destinations on this JMS server since the last reset.

           
    Privileges Read only
    Typelong

    DestinationsTotalCount

    The number of destinations instantiated on this JMS server since the last reset.

           
    Privileges Read only
    Typelong

    HealthState

    The health state of this JMS server.

           
    Privileges Read only
    Typeweblogic.health.HealthState

    InsertionPaused

    Returns the current insertion paused state of the JMSServer as boolean value.

           
    Privileges Read only
    Typeboolean

    InsertionPausedState

    Returns the current insertion paused state of the JMSServer as string value.

           
    Privileges Read only
    Typejava.lang.String

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    MessagesCurrentCount

    The current number of messages stored on this JMS server. This number does not include the pending messages.

           
    Privileges Read only
    Typelong

    MessagesHighCount

    The peak number of messages stored in the JMS server since the last reset.

           
    Privileges Read only
    Typelong

    MessagesPageableCurrentCount

    Return the number of messages that are currently available for paging in this JMS server but have not yet been paged out. Note that due to internal implementation details, this count may be zero even if "PageableByteCurrentCount" is zero.

           
    Privileges Read only
    Typeint

    MessagesPagedInTotalCount

    Return the total number of messages that were read from the paging directory since the JMS server was started.

           
    Privileges Read only
    Typeint

    MessagesPagedOutTotalCount

    Return the total number of messages that were written to the paging directory since the JMS server was started.

           
    Privileges Read only
    Typeint

    MessagesPendingCount

    The current number of messages pending (unacknowledged or uncommitted) stored on this JMS server.

    Pending messages are over and above the current number of messages.

           
    Privileges Read only
    Typelong

    MessagesReceivedCount

    The number of messages received on this destination since the last reset.

           
    Privileges Read only
    Typelong

    MessagesThresholdTime

    The amount of time in the threshold condition since the last reset.

           
    Privileges Read only
    Typelong

    Name

    The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

           
    Privileges Read only
    Typejava.lang.String

    ObjectName

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

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    PagingAllocatedIoBufferBytes

    See PersistentStoreRuntimeMBean.AllocatedIoBufferBytes

           
    Privileges Read only
    Typelong

    PagingAllocatedWindowBufferBytes

    See PersistentStoreRuntimeMBean.AllocatedWindowBufferBytes

           
    Privileges Read only
    Typelong

    PagingPhysicalWriteCount

    See PersistentStoreRuntimeMBean.PhysicalWriteCount

           
    Privileges Read only
    Typelong

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    PendingTransactions

    Returns an array of Xids representing transaction branches that exist onthis JMS server in the pending state, i.e. branches that have been prepared by the transaction manager but not yet committed or rolled back.

    For more information, see:

           
    Privileges Read only
    Typeclass java.lang.String[]

    ProductionPaused

    Returns the current production paused state of the JMSServer as boolean value.

           
    Privileges Read only
    Typeboolean

    ProductionPausedState

    Returns the current production paused state of the JMSServer as string value.

           
    Privileges Read only
    Typejava.lang.String

    Registered

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

    Deprecated.

           
    Privileges Read only
    Typeboolean

    SessionPoolsCurrentCount

    The current number of session pools instantiated on this JMS server.

           
    Privileges Read only
    Typelong

    SessionPoolsHighCount

    The peak number of session pools instantiated on this JMS server since the last reset.

           
    Privileges Read only
    Typelong

    SessionPoolsTotalCount

    The number of session pools instantiated on this JMS server since the last reset.

           
    Privileges Read only
    Typelong

    Transactions

    Returns an array of Xids representing transaction branches that exist on this JMS server in any state.

    For more information, see:

           
    Privileges Read only
    Typeclass java.lang.String[]

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String


    Operations

    This section describes the following operations:


    closeCursor

    Releases the server-side resources associated with the cursor and removes the runtime MBean instance.

       
    Operation Name"closeCursor"
    ParametersObject [] {  cursorHandle }

    where:

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

      The cursor handle.

    SignatureString [] { "java.lang.String" }
    ReturnsVoid
    Exceptions
    • weblogic.management.ManagementException

    forceCommit

    Causes the work associated with the specified transaction branch to be committed.

       
    Operation Name"forceCommit"
    ParametersObject [] {  xid }

    where:

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

      An xid in string representation for a JMS transaction branch.

    SignatureString [] { "java.lang.String" }
    ReturnsVoid
    Exceptions
    • weblogic.management.ManagementException

    forceRollback

    Causes the work associated with the specified transaction branch to be rolled back.

       
    Operation Name"forceRollback"
    ParametersObject [] {  xid }

    where:

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

      An xid in string representation for a JMS transaction branch.

    SignatureString [] { "java.lang.String" }
    ReturnsVoid
    Exceptions
    • weblogic.management.ManagementException

    getCursorEndPosition

    Returns the cursor end position in the result set.

       
    Operation Name"getCursorEndPosition"
    ParametersObject [] {  cursorHandle }

    where:

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

      The cursor handle.

    SignatureString [] { "java.lang.String" }
    ReturnsLong
    Exceptions
    • weblogic.management.ManagementException

    getCursorSize

    Returns the number of items in the result set.

       
    Operation Name"getCursorSize"
    ParametersObject [] {  cursorHandle }

    where:

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

      The cursor handle.

    SignatureString [] { "java.lang.String" }
    ReturnsLong
    Exceptions
    • weblogic.management.ManagementException

    getCursorStartPosition

    Returns the cursor start position in the result set.

       
    Operation Name"getCursorStartPosition"
    ParametersObject [] {  cursorHandle }

    where:

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

      The cursor handle.

    SignatureString [] { "java.lang.String" }
    ReturnsLong
    Exceptions
    • weblogic.management.ManagementException

    getItems

    Returns an array of items from the specified cursor location. The new cursor start position will be the location after the old cursor end position. The size of the array returned is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the return array is zero. In this case, the cursor position will not change.

    For more information, see:

       
    Operation Name"getItems"
    ParametersObject [] {  cursorHandlestartcount }

    where:

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

      The cursor handle.

    • start is an object of type java.lang.Long that specifies:

      The new cursor start location.

    • count is an object of type java.lang.Integer that specifies:

      The maximum number of items to return.

    SignatureString [] { "java.lang.String", "java.lang.Long", "java.lang.Integer" }
    Returns class
    Exceptions
    • weblogic.management.ManagementException

    getMessage

    Given a JMS message ID this method returns the corresponding message from the queue. If no message with the specified message ID exists on the destination, a null value is returned.

    For more information, see:

       
    Operation Name"getMessage"
    ParametersObject [] {  cursorHandlemessageID }

    where:

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

      The handle of the cursor.

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

      The JMS message ID of the requested message.

    SignatureString [] { "java.lang.String", "java.lang.String" }
    ReturnsCompositeData
    Exceptions
    • weblogic.management.ManagementException

    getMessage

    Returns the message associated with the specified cursor handle.

    For more information, see:

       
    Operation Name"getMessage"
    ParametersObject [] {  cursorHandlemessageHandle }

    where:

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

      The handle of the cursor.

    • messageHandle is an object of type java.lang.Long that specifies:

      The handle of the message within the cursor.

    SignatureString [] { "java.lang.String", "java.lang.Long" }
    ReturnsCompositeData
    Exceptions
    • weblogic.management.ManagementException
      ManagementException Thrown when an error occurs while performing the operation.

    getMessages

    Returns a set of messages that are associated with a JMS transaction branch. Note that the result set is returned to the caller in the form of a message cursor that may contain messages from several destinations on this JMS server.

    The timeout parameter specifies the amount of time in seconds for which the cursor is valid. Upon timeout expiration the cursor is invalidated and the associated resources released.

    For more information, see:

       
    Operation Name"getMessages"
    ParametersObject [] {  xidtimeoutSeconds }

    where:

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

      An Xid in string representation for a JMS transaction branch.

    • timeoutSeconds is an object of type java.lang.Integer that specifies:

      The last access timeout for the cursor. The cursor resources will be reclaimed if it is not accessed within the specified time interval. A value of 0 indicates no timeout.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    ReturnsString
    Exceptions
    • weblogic.management.ManagementException

    getNext

    Returns an array of items starting from the current cursor end position. The new cursor start position is set to be the location of the first item returned to the caller. The new cursor end position is set according to the size of the array returned, which is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the array is zero. In this case, the cursor position will not change.

    For more information, see:

       
    Operation Name"getNext"
    ParametersObject [] {  cursorHandlecount }

    where:

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

      The cursor handle.

    • count is an object of type java.lang.Integer that specifies:

      The maximum number of items to return.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    Returns class
    Exceptions
    • weblogic.management.ManagementException

    getPrevious

    Returns an array of items up to the current cursor start position. The new start position will be placed at the location of the first item in the set returned to the caller. The new cursor end position will be placed at the location after the last item in the set that is returned.

    For more information, see:

       
    Operation Name"getPrevious"
    ParametersObject [] {  cursorHandlecount }

    where:

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

      The cursor handle.

    • count is an object of type java.lang.Integer that specifies:

      The maximum number of item to return.

    SignatureString [] { "java.lang.String", "java.lang.Integer" }
    Returns class
    Exceptions
    • weblogic.management.ManagementException

    getTransactionStatus

    Given an Xid this method returns the JTA status of the associated JMS transaction branch.

    For more information, see:

       
    Operation Name"getTransactionStatus"
    ParametersObject [] {  xid }

    where:

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

      An Xid in string representation for a JMS transaction branch.

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

    pauseConsumption

    Pauses the consumption operation on all the destinations hosted by the JMSServer.

    When the JMSServer is paused for consumption, all of its destination's state is marked as "consumption paused" and all the new synchronous receive operations will block until the destination is resumed and there are messages available for consumption. All the synchronous receive with blocking timeout will block until the timeout happens during the consumption paused state.

    All the asynchronous consumers attached to that destination will not get any messages delivered to them while the destination in "consumption paused" state.

    After a successful consumption "pause" operation, the user has to explicitly "resume" the destination to allow for any further consume operations on that destination

       
    Operation Name"pauseConsumption"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • javax.jms.JMSException

    pauseInsertion

    Pauses the appearance of any messages on all the destinations of the JMSServer, that are result of the in-flight work completion on all the destinations hosted by this JMSServer.

    Definition of In-Flight work

    The definitions below are based on the current implementation of WebLogic JMS subsystem.

    For more information, see:

       
    Operation Name"pauseInsertion"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • javax.jms.JMSException
      JMSException Thrown when an internal JMS error occurs while pausing the insertion.

    pauseProduction

    Pauses the new message production on all the destinations hosted by the JMSServer.

    When the production paused, it would prevent any new produce operations from both new and existing producers attached to the destinations. When the destination is "resumed from production pause", all the new message production is allowed from both new and existing producers attached to that destination.

    For more information, see:

       
    Operation Name"pauseProduction"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • javax.jms.JMSException
      JMSException Thrown when an internal JMS error occurs while pausing the production.

    resumeConsumption

    Resumes the consumption operation on all the destinations hosted by the JMSSever.

    The state of the destinations shall be marked as "consumption enabled" thus allowing all the "consuming" activity to continue normally.

    Invoking this API on a JMSServer that is currently not in "consumption paused" state has no effect.

       
    Operation Name"resumeConsumption"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • javax.jms.JMSException
      JMSException Thrown when an internal JMS error occurs while resuming the consumption.

    resumeInsertion

    Resumes the in-flight message production operation on all the destinations hosted by the JMSServer. The state of the JMSServer shall be marked as "insertion enabled" thus allowing all the messages from in-flight work completion are alloed to appear on the destinations.

    Invoking this API on a JMSServer that is currently not in "insertion paused" state has no effect.

       
    Operation Name"resumeInsertion"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • javax.jms.JMSException
      JMSException Thrown when an internal JMS error occurs while resuming the insertion.

    resumeProduction

    Resumes the new message production operation on all the destinations hosted by the JMSServer. The state of the JMSServer shall be marked as "production enabled" thus allowing all the new "producing" activity to continue normally. Invoking this API on a JMSServer that is currently not in "production paused" state has no effect.

       
    Operation Name"resumeProduction"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • javax.jms.JMSException
      JMSException Thrown when an internal JMS error occurs while resuming the production.

    sort

    Sorts the entire message result set managed by the cursor according to the JMS header attributes specified. The cursor position is set to the new position of the message corresponding to the "start" location before the sort is performed. The method returns the new cursor position.

    For more information, see:

       
    Operation Name"sort"
    ParametersObject [] {  cursorHandlestartfieldsascending }

    where:

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

      The handle of the cursor.

    • start is an object of type java.lang.Long that specifies:

      The location of the message before the sort that will be the first message returned after the sort. A value of -1 will place the cursor start position at the head of the new sort order.

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

      The JMS header attributes on which to sort.

    • ascending is an object of type [Ljava.lang.Boolean; that specifies:

      Determines whether the sort of the corresponding fields element is in ascending or descending order.

    SignatureString [] { "java.lang.String", "java.lang.Long", "[Ljava.lang.String;", "[Ljava.lang.Boolean;" }
    ReturnsLong
    Exceptions
    • weblogic.management.ManagementException
      ManagementException Thrown when an internal JMS error occurs while processing the request.