org.objectweb.joram.mom.proxies
Interface UserAgentMBean

All Superinterfaces:
AgentMBean
All Known Implementing Classes:
UserAgent

public interface UserAgentMBean
extends AgentMBean


Method Summary
 void delete()
          Deletes this proxy.
 java.lang.String getDMQId()
          Returns the default DMQ for subscription of this user.
 java.lang.String getName()
          Returns the name of this queue, or its id if not set.
 int getNbMaxMsg()
          Returns the default maximum number of message for the subscription of this user.
 long getNbMsgsSentToDMQSinceCreation()
          Returns the number of erroneous messages forwarded to the DMQ since creation time of this proxy..
 long getPeriod()
          Returns the period value of this queue, -1 if not set.
 java.lang.String[] getSubscriptionNames()
          Returns the list of subscriptions for this user.
 int getThreshold()
          Returns the default threshold for the subscription of this user. 0 stands for no threshold, -1 for value not set.
 void setNbMaxMsg(int nbMaxMsg)
          Sets the maximum number of message for the subscription of this user.
 void setPeriod(long period)
          Sets or unsets the period for this queue.
 void setThreshold(int threshold)
          Sets the default threshold for the subscription of this user. 0 stands for no threshold, -1 for value not set.
 java.lang.String toString()
          Returns a string representation of this user's proxy.
 
Methods inherited from interface fr.dyade.aaa.agent.AgentMBean
getAgentId, getCommitTime, getReactNb, getReactTime, isFixed
 

Method Detail

getName

java.lang.String getName()
Returns the name of this queue, or its id if not set.

Specified by:
getName in interface AgentMBean
Returns:
the name of this queue; its id if not set.

getPeriod

long getPeriod()
Returns the period value of this queue, -1 if not set.

Returns:
the period value of this queue; -1 if not set.

setPeriod

void setPeriod(long period)
Sets or unsets the period for this queue.

Parameters:
period - The period value to be set or -1 for unsetting previous value.

getSubscriptionNames

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.

toString

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

Specified by:
toString in interface AgentMBean
Overrides:
toString in class java.lang.Object
Returns:
A string representation of this agent.

getNbMsgsSentToDMQSinceCreation

long getNbMsgsSentToDMQSinceCreation()
Returns the number of erroneous messages forwarded to the DMQ since creation time of this proxy..

Returns:
the number of erroneous messages forwarded to the DMQ.

getDMQId

java.lang.String getDMQId()
Returns the default DMQ for subscription of this user.

Returns:
the default DMQ for subscription of this user.

getThreshold

int getThreshold()
Returns the default threshold for the subscription of this user. 0 stands for no threshold, -1 for value not set.

Returns:
the maximum number of message if set; -1 otherwise.

setThreshold

void setThreshold(int threshold)
Sets the default threshold for the subscription of this user. 0 stands for no threshold, -1 for value not set.

Parameters:
threshold - the threshold to set.

getNbMaxMsg

int getNbMaxMsg()
Returns the default maximum number of message for the subscription of this user. If the limit is unset the method returns -1.

Returns:
the maximum number of message if set; -1 otherwise.

setNbMaxMsg

void setNbMaxMsg(int nbMaxMsg)
Sets the maximum number of message for the subscription of this user.

Parameters:
nbMaxMsg - the maximum number of message (-1 set no limit).

delete

void delete()
Deletes this proxy.

Specified by:
delete in interface AgentMBean


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