Joram ${version}

org.objectweb.joram.mom.proxies
Interface ProxyImplMBean

All Known Implementing Classes:
ProxyImpl

public interface ProxyImplMBean


Method Summary
 void deleteSubscriptionMessage(java.lang.String subName, java.lang.String msgId)
          Deletes a particular pending message in a subscription.
 int getNbMaxMsg(java.lang.String subName)
          Returns the maximum number of message for identified subscription.
 javax.management.openmbean.CompositeDataSupport getSubscriptionMessage(java.lang.String subName, java.lang.String msgId)
          Returns the description of a particular pending message in a subscription.
 int getSubscriptionMessageCount(java.lang.String subName)
          Returns the number of pending messages for an identified subscription.
 java.lang.String[] getSubscriptionMessageIds(java.lang.String subName)
          Returns the list of message's identifiers for a subscription.
 java.lang.String[] getSubscriptionNames()
          Returns the list of subscriptions for this user.
 java.lang.String getSubscriptionTopicId(java.lang.String subName)
          Returns the unique identifier of the topic related to this subscription.
 void setNbMaxMsg(java.lang.String subName, int nbMaxMsg)
          Sets the maximum number of message for identified subscription.
 java.lang.String toString()
          Returns a string representation of this user's proxy.
 

Method Detail

toString

public java.lang.String toString()
Returns a string representation of this user's proxy.


getSubscriptionNames

public java.lang.String[] getSubscriptionNames()
Returns the list of subscriptions for this user. Each subscription is identified by its unique 'symbolic' name.

Returns:
The list of subscriptions for this user.

getSubscriptionMessageCount

public int getSubscriptionMessageCount(java.lang.String subName)
Returns the number of pending messages for an identified subscription. The subscription must be identified by its unique 'symbolic' name.

Parameters:
subName - The subscription unique name.
Returns:
The number of pending message for the subscription.

getSubscriptionTopicId

public java.lang.String getSubscriptionTopicId(java.lang.String subName)
Returns the unique identifier of the topic related to this subscription.

Parameters:
subName - The subscription unique name.
Returns:
the unique identifier of the topic related to this subscription.

getSubscriptionMessageIds

public java.lang.String[] getSubscriptionMessageIds(java.lang.String subName)
Returns the list of message's identifiers for a subscription. The subscription must be identified by its unique 'symbolic' name.

Parameters:
subName - The subscription unique name.
Returns:
the list of message's identifiers for the subscription.

getSubscriptionMessage

public javax.management.openmbean.CompositeDataSupport getSubscriptionMessage(java.lang.String subName,
                                                                              java.lang.String msgId)
                                                                       throws java.lang.Exception
Returns the description of a particular pending message in a subscription. The subscription is identified by its unique name, the message is pointed out through its unique identifier. The description includes the type and priority of the message.

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

deleteSubscriptionMessage

public void deleteSubscriptionMessage(java.lang.String subName,
                                      java.lang.String msgId)
Deletes a particular pending message in a subscription. The subscription is identified by its unique name, the message is pointed out through its unique identifier.

Parameters:
subName - The subscription unique name.
msgId - The unique message's identifier.

getNbMaxMsg

public int getNbMaxMsg(java.lang.String subName)
Returns the maximum number of message for identified subscription. The subscription is identified by its unique name, if the limit is unset the method returns -1.

Parameters:
subName - The subscription unique name.
Returns:
the maximum number of message for subscription if set; -1 otherwise.

setNbMaxMsg

public void setNbMaxMsg(java.lang.String subName,
                        int nbMaxMsg)
Sets the maximum number of message for identified subscription. The subscription is identified by its unique name.

Parameters:
subName - The subscription unique name.
nbMaxMsg - the maximum number of message for subscription (-1 set no limit).

Joram ${version}

Copyright © 2005 Scalagent - All rights reserved