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

All Known Implementing Classes:
User

public interface UserMBean


Method Summary
 void addInterceptorsIN(java.lang.String interceptors)
          add interceptors
 void addInterceptorsOUT(java.lang.String interceptors)
          add interceptors
 void clearSubscription(java.lang.String subName)
           
 void delete()
          Removes this user.
 void deleteMessage(java.lang.String subName, java.lang.String msgId)
           
 java.lang.String getDMQId()
          Returns the dead message queue Id for this user, null if not set.
 java.lang.String getInterceptorsIN()
          get interceptors.
 java.lang.String getInterceptorsOUT()
          get interceptors.
 java.lang.String getMessageDigest(java.lang.String subName, java.lang.String msgId)
           
 java.util.Properties getMessageHeader(java.lang.String subName, java.lang.String msgId)
           
 java.lang.String[] getMessageIds(java.lang.String subName)
           
 java.util.Properties getMessageProperties(java.lang.String subName, java.lang.String msgId)
           
 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)
           
 Subscription[] getSubscriptions()
          Returns the subscriptions owned by a user.
 java.lang.String getSubscriptionString(java.lang.String subName)
          Returns a subscription.
 int getThreshold()
          Returns the threshold for this user, -1 if not set.
 void removeInterceptorsIN(java.lang.String interceptors)
          remove interceptors
 void removeInterceptorsOUT(java.lang.String interceptors)
          remove interceptors
 void setDMQId(java.lang.String dmqId)
          Admin method setting a given dead message queue Id 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

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

Overrides:
toString in class java.lang.Object

getName

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


delete

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

Throws:
java.net.ConnectException
AdminException

setDMQId

void setDMQId(java.lang.String dmqId)
              throws java.net.ConnectException,
                     AdminException
Admin method setting a given dead message queue Id for this user.

Throws:
java.net.ConnectException
AdminException

setThreshold

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

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

getNbMaxMsg

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

getDMQId

java.lang.String getDMQId()
                          throws java.net.ConnectException,
                                 AdminException
Returns the dead message queue Id for this user, null if not set.

Throws:
java.net.ConnectException
AdminException

getThreshold

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

Throws:
java.net.ConnectException
AdminException

getSubscriptions

Subscription[] getSubscriptions()
                                throws AdminException,
                                       java.net.ConnectException
Returns the subscriptions owned by a user.

Throws:
AdminException
java.net.ConnectException

getSubscriptionString

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

Throws:
java.net.ConnectException
AdminException

getSubscription

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

getMessageIds

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

getMessageDigest

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

getMessageHeader

java.util.Properties getMessageHeader(java.lang.String subName,
                                      java.lang.String msgId)
                                      throws java.net.ConnectException,
                                             AdminException,
                                             javax.jms.JMSException
Throws:
java.net.ConnectException
AdminException
javax.jms.JMSException

getMessageProperties

java.util.Properties getMessageProperties(java.lang.String subName,
                                          java.lang.String msgId)
                                          throws java.net.ConnectException,
                                                 AdminException,
                                                 javax.jms.JMSException
Throws:
java.net.ConnectException
AdminException
javax.jms.JMSException

deleteMessage

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

clearSubscription

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

getProxyId

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


addInterceptorsIN

void addInterceptorsIN(java.lang.String interceptors)
                       throws java.net.ConnectException,
                              AdminException
add interceptors

Parameters:
interceptors - list of string className interceptor (separate with ",")
Throws:
java.net.ConnectException
AdminException

getInterceptorsIN

java.lang.String getInterceptorsIN()
                                   throws java.net.ConnectException,
                                          AdminException
get interceptors.

Returns:
list of string className interceptor (separate with ",")
Throws:
java.net.ConnectException
AdminException

removeInterceptorsIN

void removeInterceptorsIN(java.lang.String interceptors)
                          throws java.net.ConnectException,
                                 AdminException
remove interceptors

Parameters:
interceptors - list of string className interceptor (separate with ",")
Throws:
java.net.ConnectException
AdminException

addInterceptorsOUT

void addInterceptorsOUT(java.lang.String interceptors)
                        throws java.net.ConnectException,
                               AdminException
add interceptors

Parameters:
interceptors - list of string className interceptor (separate with ",")
Throws:
java.net.ConnectException
AdminException

getInterceptorsOUT

java.lang.String getInterceptorsOUT()
                                    throws java.net.ConnectException,
                                           AdminException
get interceptors.

Returns:
list of string className interceptor (separate with ",")
Throws:
java.net.ConnectException
AdminException

removeInterceptorsOUT

void removeInterceptorsOUT(java.lang.String interceptors)
                           throws java.net.ConnectException,
                                  AdminException
remove interceptors

Parameters:
interceptors - list of string className interceptor (separate with ",")
Throws:
java.net.ConnectException
AdminException


Copyright © 2011 ScalAgent D.T.. All Rights Reserved.