Package org.objectweb.joram.mom.proxies

Interface ClientSubscriptionMBean

  • All Known Implementing Classes:
    ClientSubscription
    public interface ClientSubscriptionMBean

    • Method Detail

      • deleteMessage

        void deleteMessage​(String msgId)
        Deletes a particular pending message in the subscription. The message is pointed out through its unique identifier.
        Parameters:
        msgId - The unique message's identifier.

      • setNbMaxMsg

        void setNbMaxMsg​(int nbMaxMsg)
        Sets the maximum number of message for the subscription.
        Parameters:
        nbMaxMsg - the maximum number of message for subscription (-1 set no limit).

      • clear

        void clear()
        Deletes all messages

      • getContextId

        int getContextId()
        Returns the subscription's context identifier.

      • getSubRequestId

        int getSubRequestId()
        Returns the identifier of the subscribing request.

      • getName

        String getName()
        Returns the name of the subscription.

      • getTopicIdAsString

        String getTopicIdAsString()
        Returns the identifier of the subscription topic.

      • getSelector

        String getSelector()
        Returns the selector.

      • getDurable

        boolean getDurable()
        Returns true if the subscription is durable.

      • getActive

        int getActive()
        Returns the maximum number of messages per request if the subscription is active, 0 if the subscription is inactive.

      • getThreshold

        int getThreshold()
        Returns the threshold above which messages are considered undeliverable because constantly denied.
        Returns:
        the threshold if set; -1 otherwise.

      • getNbMaxMsg

        int getNbMaxMsg()
        Returns the maximum number of message for the subscription. If the limit is unset the method returns -1.
        Returns:
        the maximum number of message for subscription if set; -1 otherwise.

      • getPendingMessageCount

        int getPendingMessageCount()
        Returns the number of pending messages for the subscription.
        Returns:
        The number of pending message for the subscription.

      • getDeliveredMessageCount

        int getDeliveredMessageCount()
        Returns the number of messages delivered and waiting for acknowledge.
        Returns:
        The number of messages delivered and waiting for acknowledge.

      • getMessageIds

        String[] getMessageIds()
        Returns the list of message's identifiers for the subscription.
        Returns:
        the list of message's identifiers for the subscription.

      • getNbMsgsSentToDMQSinceCreation

        long getNbMsgsSentToDMQSinceCreation()
        Returns the number of erroneous messages forwarded to the DMQ since creation time of this subscription.
        Returns:
        the number of erroneous messages forwarded to the DMQ.

      • getNbMsgsDeliveredSinceCreation

        long getNbMsgsDeliveredSinceCreation()
        Returns the number of messages delivered to the client since creation time of this subscription.
        Returns:
        the number of delivered messages.

      • getMessage

        CompositeData getMessage​(String msgId)
                  throws Exception
        Returns the description of a particular pending message. The message is pointed out through its unique identifier.
        Parameters:
        msgId - The unique message's identifier.
        Returns:
        the description of the message.
        Throws:
        Exception
        See Also:
        MessageJMXWrapper