Joram ${version}

org.objectweb.joram.client.jms.admin
Interface UserMBean

All Known Implementing Classes:
User

public interface UserMBean


Method Summary
 void clearSubscription(java.lang.String subName)
           
 void delete()
          Removes this user.
 void deleteMessage(java.lang.String subName, java.lang.String msgId)
           
 DeadMQueue getDMQ()
          Returns the dead message queue for this user, null if not set.
 java.lang.String[] getMessageIds(java.lang.String subName)
           
 java.lang.String getName()
          Returns the user name.
 int getNbMaxMsg(java.lang.String subName)
           
 java.lang.String getProxyId()
          Returns the identifier of the user's proxy.
 Subscription getSubscription(java.lang.String subName)
           
 java.util.List getSubscriptionList()
          Returns the subscriptions owned by a user.
 Subscription[] getSubscriptions()
           
 java.lang.String getSubscriptionString(java.lang.String subName)
          Returns a subscription.
 int getThreshold()
          Returns the threshold for this user, -1 if not set.
 Message readMessage(java.lang.String subName, java.lang.String msgId)
           
 void setDMQ(DeadMQueue dmq)
          Admin method setting a given dead message queue for this user.
 void setNbMaxMsg(java.lang.String subName, int nbMaxMsg)
           
 void setThreshold(int thresh)
          Admin method setting a given value as the threshold for this user.
 java.lang.String toString()
          Returns a string view of this User instance.
 

Method Detail

toString

public java.lang.String toString()
Returns a string view of this User instance.


getName

public java.lang.String getName()
Returns the user name.


delete

public void delete()
            throws java.net.ConnectException,
                   AdminException
Removes this user.

Throws:
java.net.ConnectException
AdminException

setDMQ

public void setDMQ(DeadMQueue dmq)
            throws java.net.ConnectException,
                   AdminException
Admin method setting a given dead message queue for this user.

Throws:
java.net.ConnectException
AdminException

setThreshold

public void setThreshold(int thresh)
                  throws java.net.ConnectException,
                         AdminException
Admin method setting a given value as the threshold for this user.

Throws:
java.net.ConnectException
AdminException

setNbMaxMsg

public void setNbMaxMsg(java.lang.String subName,
                        int nbMaxMsg)
                 throws java.net.ConnectException,
                        AdminException
Throws:
java.net.ConnectException
AdminException

getNbMaxMsg

public int getNbMaxMsg(java.lang.String subName)
                throws java.net.ConnectException,
                       AdminException
Throws:
java.net.ConnectException
AdminException

getDMQ

public DeadMQueue getDMQ()
                  throws java.net.ConnectException,
                         AdminException
Returns the dead message queue for this user, null if not set.

Throws:
java.net.ConnectException
AdminException

getThreshold

public int getThreshold()
                 throws java.net.ConnectException,
                        AdminException
Returns the threshold for this user, -1 if not set.

Throws:
java.net.ConnectException
AdminException

getSubscriptionList

public java.util.List getSubscriptionList()
                                   throws java.net.ConnectException,
                                          AdminException
Returns the subscriptions owned by a user.

Throws:
java.net.ConnectException
AdminException

getSubscriptions

public Subscription[] getSubscriptions()
                                throws AdminException,
                                       java.net.ConnectException
Throws:
AdminException
java.net.ConnectException

getSubscriptionString

public java.lang.String getSubscriptionString(java.lang.String subName)
                                       throws java.net.ConnectException,
                                              AdminException
Returns a subscription.

Throws:
java.net.ConnectException
AdminException

getSubscription

public Subscription getSubscription(java.lang.String subName)
                             throws AdminException,
                                    java.net.ConnectException
Throws:
AdminException
java.net.ConnectException

getMessageIds

public java.lang.String[] getMessageIds(java.lang.String subName)
                                 throws java.net.ConnectException,
                                        AdminException
Throws:
java.net.ConnectException
AdminException

readMessage

public Message readMessage(java.lang.String subName,
                           java.lang.String msgId)
                    throws AdminException,
                           java.net.ConnectException,
                           javax.jms.JMSException
Throws:
AdminException
java.net.ConnectException
javax.jms.JMSException

deleteMessage

public void deleteMessage(java.lang.String subName,
                          java.lang.String msgId)
                   throws AdminException,
                          java.net.ConnectException
Throws:
AdminException
java.net.ConnectException

clearSubscription

public void clearSubscription(java.lang.String subName)
                       throws AdminException,
                              java.net.ConnectException
Throws:
AdminException
java.net.ConnectException

getProxyId

public java.lang.String getProxyId()
Returns the identifier of the user's proxy.


Joram ${version}

Copyright © 2005 Scalagent - All rights reserved