Package org.objectweb.joram.client.jms.admin

Interface UserMBean

All Known Implementing Classes:

User

public interface UserMBean

Method Summary

Modifier and Type	Method	Description
void	addInterceptorsIN(String interceptors)	add interceptors
void	addInterceptorsOUT(String interceptors)	add interceptors
void	clearSubscription(String subName)
void	delete()	Removes this user.
void	deleteMessage(String subName, String msgId)
String	getDMQId()	Returns the dead message queue Id for this user, null if not set.
String	getInterceptorsIN()	get interceptors.
String	getInterceptorsOUT()	get interceptors.
String	getMessageDigest(String subName, String msgId)
Properties	getMessageHeader(String subName, String msgId)
String[]	getMessageIds(String subName)
Properties	getMessageProperties(String subName, String msgId)
String	getName()	Returns the user name.
int	getNbMaxMsg(String subName)
String	getProxyId()	Returns the identifier of the user's proxy.
Subscription	getSubscription(String subName)
Subscription[]	getSubscriptions()	Returns the subscriptions owned by a user.
String	getSubscriptionString(String subName)	Returns a subscription.
int	getThreshold()	Returns the threshold for this user, -1 if not set.
void	removeInterceptorsIN(String interceptors)	remove interceptors
void	removeInterceptorsOUT(String interceptors)	remove interceptors
void	setDMQId(String dmqId)	Admin method setting a given dead message queue Id for this user.
void	setNbMaxMsg(String subName, int nbMaxMsg)
void	setThreshold(int thresh)	Admin method setting a given value as the threshold for this user.
String	toString()	Returns a string view of this User instance.

Method Detail

toString

String toString()

Returns a string view of this User instance.

Overrides:

toString in class Object

getName

String getName()

Returns the user name.

delete

void delete()
     throws ConnectException,
            AdminException

Removes this user.

Throws:

ConnectException

AdminException

setDMQId

void setDMQId(String dmqId)
       throws ConnectException,
              AdminException

Admin method setting a given dead message queue Id for this user.

Throws:

ConnectException

AdminException

setThreshold

void setThreshold(int thresh)
           throws ConnectException,
                  AdminException

Admin method setting a given value as the threshold for this user.

Throws:

ConnectException

AdminException

setNbMaxMsg

void setNbMaxMsg(String subName,
                 int nbMaxMsg)
          throws ConnectException,
                 AdminException

Throws:

ConnectException

AdminException

getNbMaxMsg

int getNbMaxMsg(String subName)
         throws ConnectException,
                AdminException

Throws:

ConnectException

AdminException

getDMQId

String getDMQId()
         throws ConnectException,
                AdminException

Returns the dead message queue Id for this user, null if not set.

Throws:

ConnectException

AdminException

getThreshold

int getThreshold()
          throws ConnectException,
                 AdminException

Returns the threshold for this user, -1 if not set.

Throws:

ConnectException

AdminException

getSubscriptions

Subscription[] getSubscriptions()
                         throws AdminException,
                                ConnectException

Returns the subscriptions owned by a user.

Throws:

AdminException

ConnectException

getSubscriptionString

String getSubscriptionString(String subName)
                      throws ConnectException,
                             AdminException

Returns a subscription.

Throws:

ConnectException

AdminException

getSubscription

Subscription getSubscription(String subName)
                      throws AdminException,
                             ConnectException

Throws:

AdminException

ConnectException

getMessageIds

String[] getMessageIds(String subName)
                throws ConnectException,
                       AdminException

Throws:

ConnectException

AdminException

getMessageDigest

String getMessageDigest(String subName,
                        String msgId)
                 throws AdminException,
                        ConnectException,
                        JMSException

Throws:

AdminException

ConnectException

JMSException

getMessageHeader

Properties getMessageHeader(String subName,
                            String msgId)
                     throws ConnectException,
                            AdminException,
                            JMSException

Throws:

ConnectException

AdminException

JMSException

getMessageProperties

Properties getMessageProperties(String subName,
                                String msgId)
                         throws ConnectException,
                                AdminException,
                                JMSException

Throws:

ConnectException

AdminException

JMSException

deleteMessage

void deleteMessage(String subName,
                   String msgId)
            throws AdminException,
                   ConnectException

Throws:

AdminException

ConnectException

clearSubscription

void clearSubscription(String subName)
                throws AdminException,
                       ConnectException

Throws:

AdminException

ConnectException

getProxyId

String getProxyId()

Returns the identifier of the user's proxy.

addInterceptorsIN

void addInterceptorsIN(String interceptors)
                throws ConnectException,
                       AdminException

add interceptors

Parameters:

interceptors - list of string className interceptor (separate with ",")

Throws:

ConnectException

AdminException

getInterceptorsIN

String getInterceptorsIN()
                  throws ConnectException,
                         AdminException

get interceptors.

Returns:

list of string className interceptor (separate with ",")

Throws:

ConnectException

AdminException

removeInterceptorsIN

void removeInterceptorsIN(String interceptors)
                   throws ConnectException,
                          AdminException

remove interceptors

Parameters:

interceptors - list of string className interceptor (separate with ",")

Throws:

ConnectException

AdminException

addInterceptorsOUT

void addInterceptorsOUT(String interceptors)
                 throws ConnectException,
                        AdminException

add interceptors

Parameters:

interceptors - list of string className interceptor (separate with ",")

Throws:

ConnectException

AdminException

getInterceptorsOUT

String getInterceptorsOUT()
                   throws ConnectException,
                          AdminException

get interceptors.

Returns:

list of string className interceptor (separate with ",")

Throws:

ConnectException

AdminException

removeInterceptorsOUT

void removeInterceptorsOUT(String interceptors)
                    throws ConnectException,
                           AdminException

remove interceptors

Parameters:

interceptors - list of string className interceptor (separate with ",")

Throws:

ConnectException

AdminException