JMSDestinationRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class is used for monitoring a WebLogic JMS destination (topic or queue).

   
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.JMSDestinationRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.


Related MBeans

This section describes attributes that provide access to other MBeans.


    DurableSubscribers

    An array of durable subscriber run-time MBeans for this destination.

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


    Attributes

    This section describes the following attributes:


    BytesCurrentCount

    The current number of bytes stored in the destination. This does not include the pending bytes.

           
    Privileges Read only
    Typelong

    BytesHighCount

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

           
    Privileges Read only
    Typelong

    BytesPendingCount

    The number of pending bytes stored in the destination.

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

           
    Privileges Read only
    Typelong

    BytesReceivedCount

    The number of bytes received in this destination 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

    ConsumersCurrentCount

    The current number of consumers accessing this destination.

           
    Privileges Read only
    Typelong

    ConsumersHighCount

    The peak number of consumers accessing this destination since the last reset.

           
    Privileges Read only
    Typelong

    ConsumersTotalCount

    The total number of consumers accessing this destination since the last reset.

           
    Privileges Read only
    Typelong

    ConsumptionPaused

    Indicates the consumption Pause state of the destination.

           
    Privileges Read only
    Typeboolean

    ConsumptionPausedState

    The current consumption pause state of the destination.

           
    Privileges Read only
    Typejava.lang.String

    DestinationInfo

    Returns information about this destination in JMX open data representation.

    For more information, see:

           
    Privileges Read only
    Typejavax.management.openmbean.CompositeData

    DestinationType

    The destination type, either weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_QUEUE or weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_TOPIC depending upon whether the destination is a queue or topic.

           
    Privileges Read only
    Typejava.lang.String

    InsertionPaused

    Indicates the InsertionPause state of the destination.

           
    Privileges Read only
    Typeboolean

    InsertionPausedState

    The current insertion pause state of the destination.

           
    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 in the destination. This does not include the pending messages.

           
    Privileges Read only
    Typelong

    MessagesDeletedCurrentCount

    Returns the number of messages that have been deleted from the destination.

    For more information, see:

           
    Privileges Read only
    Typejava.lang.Long

    MessagesHighCount

    The peak number of messages in the destination since the last reset.

           
    Privileges Read only
    Typelong

    MessagesMovedCurrentCount

    Returns the number of messages that have been moved from the destination.

           
    Privileges Read only
    Typejava.lang.Long

    MessagesPendingCount

    The number of pending messages in the destination.

    Pending messages are over and above the current number of messages. A pending message is one that has either been sent in a transaction and not committed, or that has been received and not committed or acknowledged.

           
    Privileges Read only
    Typelong

    MessagesReceivedCount

    The number of messages received in this destination since that 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

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Paused

    Indicates whether or not the destination is paused at the current time.

    Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean#isProductionPaused

           
    Privileges Read only
    Typeboolean

    ProductionPaused

    Indicates the ProductionPause state of the destination.

           
    Privileges Read only
    Typeboolean

    ProductionPausedState

    The current production pause state of the destination.

           
    Privileges Read only
    Typejava.lang.String

    Registered

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

    Deprecated.

           
    Privileges Read only
    Typeboolean

    State

    The operational state of the destination as a String.

           
    Privileges Read only
    Typejava.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

    createDurableSubscriber

    Creates a durable subscriber on the destination with the specified client ID and subscription name. A message selector and no-local flag may also be specified.

       
    Operation Name"createDurableSubscriber"
    ParametersObject [] {  ClientIDsubscriptionNameselectornoLocal }

    where:

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

      An identifier that uniquely identifies a client connection.

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

      The name used to identify this subscription.

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

      Only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

    • noLocal is an object of type java.lang.Boolean that specifies:

      If set, inhibits the delivery of messages published by its own connection.

    SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.String", "java.lang.Boolean" }
    Returns void
    Exceptions
    • javax.jms.InvalidSelectorException
    • javax.jms.JMSException

    deleteMessages

    Deletes the set of messages from the destination that are qualified by the specified JMS message selector.

       
    Operation Name"deleteMessages"
    ParametersObject [] {  selector }

    where:

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

      A JMS message selector to identify which messages to delete.

    SignatureString [] { "java.lang.String" }
    ReturnsInteger
    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.

       
    Operation Name"getMessage"
    ParametersObject [] {  messageID }

    where:

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

      The JMS message ID of the requested message.

    SignatureString [] { "java.lang.String" }
    ReturnsCompositeData
    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

    Queries messages on the queue according to the provided message selector and state bitmask and returns a message cursor representing the result set. 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 [] {  selectortimeoutstate }

    where:

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

      A valid JMS message selector.

    • timeout 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.

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

      A messaging kernel state bitmask. Refer to the messaging kernel MessageElement interface for a description of the various message states.

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

    getMessages

    Queries messages on the queue according to the provided message selector and returns a message cursor representing the result set. 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 [] {  selectortimeout }

    where:

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

      A valid JMS message selector.

    • timeout 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

    importMessages

    Imports an array of messages into the destination. If the message ID of the message being imported matches a message already on the destination, then the existing message will be replaced. If an existing message does not exist, then the message will be produced on the destination. A produced message is subject to quota limitations.

       
    Operation Name"importMessages"
    ParametersObject [] {  messagesreplaceOnly }

    where:

    • messages is an object of type [Ljavax.management.openmbean.CompositeData; that specifies:

      An array of messages in CompositeData representation to be imported.

    • replaceOnly is an object of type java.lang.Boolean that specifies:

      When set to true an excetion will be thrown if the message ID does not exist on the target destination.

    SignatureString [] { "[Ljavax.management.openmbean.CompositeData;", "java.lang.Boolean" }
    ReturnsVoid
    Exceptions
    • weblogic.management.ManagementException

    moveMessages

       
    Operation Name"moveMessages"
    ParametersObject [] {   }

    where:

      SignatureString [] { "java.lang.String", "javax.management.openmbean.CompositeData", "java.lang.Integer" }
      ReturnsInteger
      Exceptions
      • weblogic.management.ManagementException

      moveMessages

      Moves the set of messages that match the specified selector to the target destination. The move operation is guaranteed to be atomic for the selected messages.

         
      Operation Name"moveMessages"
      ParametersObject [] {  selectortargetDestination }

      where:

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

        A JMS message selector that identifies the messages to move.

      • targetDestination is an object of type javax.management.openmbean.CompositeData that specifies:

        A JMS destination that the messages will be moved to.

      SignatureString [] { "java.lang.String", "javax.management.openmbean.CompositeData" }
      ReturnsInteger
      Exceptions
      • weblogic.management.ManagementException

      pause

      Pauses the destination so that new messages are not accepted.

      Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean#pauseProduction

         
      Operation Name"pause"
      Parametersnull
      Signaturenull
      Returns void

      pauseConsumption

      Pauses the consumption on the destination.

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

      pauseInsertion

      Pauses the insertion on the destination.

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

      pauseProduction

      Pauses the production on the destination.

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

      preDeregister

         
      Operation Name"preDeregister"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      resume

      Resumes the destination so that new messages are accepted.

      Deprecated. 9.0.0.0 Replaced by JMSDestinationRuntimeMBean#resumeProduction

         
      Operation Name"resume"
      Parametersnull
      Signaturenull
      Returns void

      resumeConsumption

      Resumes the consumption operations on the destination.

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

      resumeInsertion

      Resumes the insertion operations on the destination.

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

      resumeProduction

      Resumes the production operations on the destination.

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

      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.