Joram 5.1.0

org.objectweb.joram.mom.proxies
Interface ClientSubscriptionMBean


public interface ClientSubscriptionMBean


Method Summary
 void clear()
          Deletes all messages
 void deleteMessage(java.lang.String msgId)
          Deletes a particular pending message in the subscription.
 boolean getActive()
          Returns true if the subscription is active.
 int getContextId()
          Returns the subscription's context identifier.
 boolean getDurable()
          Returns true if the subscription is durable.
 java.lang.String[] getMessageIds()
          Returns the list of message's identifiers for the subscription.
 javax.management.openmbean.TabularData getMessagesTabularData()
          Returns the description of a particular pending message.
 java.lang.String getName()
          Returns the name of the subscription.
 int getNbMaxMsg()
          Returns the maximum number of message for the subscription.
 long getNbMsgsDeliveredSinceCreation()
          Returns the number of messages delivered to the client since creation time of this subscription.
 long getNbMsgsSentToDMQSinceCreation()
          Returns the number of erroneous messages forwarded to the DMQ since creation time of this subscription.
 int getPendingMessageCount()
          Returns the number of pending messages for the subscription.
 java.lang.String getSelector()
          Returns the selector.
 int getSubRequestId()
          Returns the identifier of the subscribing request.
 java.lang.String getTopicIdAsString()
          Returns the identifier of the subscription topic.
 void setNbMaxMsg(int nbMaxMsg)
          Sets the maximum number of message for the subscription.
 

Method Detail

deleteMessage

void deleteMessage(java.lang.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

java.lang.String getName()
Returns the name of the subscription.


getTopicIdAsString

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


getSelector

java.lang.String getSelector()
Returns the selector.


getDurable

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


getActive

boolean getActive()
Returns true if the subscription is active.


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.

getMessageIds

java.lang.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.

getMessagesTabularData

javax.management.openmbean.TabularData getMessagesTabularData()
                                                              throws java.lang.Exception
Returns the description of a particular pending message. The message is pointed out through its unique identifier. The description includes the type and priority of the message.

Parameters:
msgId - The unique message's identifier.
Returns:
the description of the message.
Throws:
java.lang.Exception

Joram 5.1.0

Copyright © 2005 Scalagent - All rights reserved