JMSDurableSubscriberRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class is used for monitoring a WebLogic JMS durable subscriber.

   
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.JMSDurableSubscriberRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Related MBeans

    This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


      DestinationRuntime

      Returns the runtime MBean of the Topic to which this durable subscriber is associated.

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


      Attributes

      This section describes the following attributes:


      Active

      Indicates whether this subscription is being used by a durable subscriber.

             
      Privileges Read only
      Typeboolean

      BytesCurrentCount

      The number of bytes received by this durable subscriber.

             
      Privileges Read only
      Typelong

      BytesPendingCount

      The number of bytes pending by this durable subscriber.

             
      Privileges Read only
      Typelong

      ClientID

      A unique client identifier for this durable subscriber.

      Note: The client ID is not necessarily equivalent to the WebLogic Server username; that is, a name used to authenticate a user in the WebLogic security realm. You can, of course, set the client ID to the WebLogic Server username, if it is appropriate for your JMS application.

             
      Privileges Read only
      Typejava.lang.String

      CurrentConsumerInfo

      Returns information about the current consumer. The information is returned in the form of an OpenMBean CompositeData object.

      For more information, see:

             
      Privileges Read only
      Typejavax.management.openmbean.CompositeData

      DestinationInfo

      Returns information about the durable subscriber's internal destination in JMX open data representation. The resulting object is intended for use in the message management APIs for identifying a target destination.

      For more information, see:

             
      Privileges Read only
      Typejavax.management.openmbean.CompositeData

      MessagesCurrentCount

      The number of messages still available by this durable subscriber.

             
      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

      Returns the peak number of messages for the durable subscriber 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 messages pending (uncommitted and unacknowledged) by this durable subscriber.

             
      Privileges Read only
      Typelong

      MessagesReceivedCount

      Returns the number of messages received by the durable subscriber since that 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

      NoLocal

      Specifies whether this durable subscriber recieves local messages it has published itself.

      To prevent this, set the noLocal parameter to true.

             
      Privileges Read only
      Typeboolean

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      Selector

      The message selector defined for this durable subscriber.

             
      Privileges Read only
      Typejava.lang.String

      SubscriptionName

      The subscription name for this durable subscriber. This name must be unique per client ID.

      Valid durable subscription names cannot include the following characters: comma ",", equals "=", colon ":", asterisk "*", percent "%", or question mark"?".

             
      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

      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

      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.

      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

      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

      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

      moveMessages

         
      Operation Name"moveMessages"
      ParametersObject [] {   }

      where:

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

        purge

        Purges all the pending and current messages for this durable subscriber.

        Deprecated. As of WLS 9.0. Use deleteMessages(String)

           
        Operation Name"purge"
        Parametersnull
        Signaturenull
        Returns void

        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.