All Superinterfaces:

AgentMBean, DestinationMBean

All Known Subinterfaces:

AcquisitionQueueMBean, ClusterQueueMBean, DistributionQueueMBean

All Known Implementing Classes:

AcquisitionQueue, AliasInQueue, AliasQueue, ClusterQueue, DistributionQueue, FtpQueue, Queue, SchedulerQueue
```
public interface QueueMBean
extends DestinationMBean
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cleanPendingMessage()`	Removes all messages that the time-to-live is expired.
`void`	`cleanWaitingRequest()`	Removes all request that the expiration time is expired.
`void`	`clear()`	Removes all pending messages.
`void`	`exportMessages(String dirpath, String selector, boolean quiet)`	Exports all messages in the specified directory.
`long`	`getConsumerLoad()`	Return the average consumer's load during last moments.
`CompositeData`	`getDelayedMessage(String msgId)`	Returns the description of a particular delayed message.
`int`	`getDelayedMessageCount()`	Returns the number of messages waiting for a delay.
`TabularData`	`getDelayedMessages()`	Returns the description of all delayed messages.
`int`	`getDeliveredMessageCount()`	Returns the number of messages delivered and waiting for acknowledge.
`int`	`getDeliveryDelay()`	Returns the Queue deliveryDelay in milliseconds.
`CompositeData`	`getMessage(String msgId)`	Returns the description of a particular pending message.
`TabularData`	`getMessages()`	Returns the description of all pending messages.
`int`	`getNbMaxMsg()`	Returns the maximum number of message for the destination.
`long`	`getNbMsgsDeniedSinceCreation()`	Returns the number of messages denied since creation time of this destination.
`int`	`getPendingMessageCount()`	Returns the number of pending messages in the queue.
`long`	`getProducerLoad()`	Return the average producer's load during last moments.
`int`	`getRedeliveryDelay()`	Return the reDeliveryDelay (unit: second)
`int`	`getThreshold()`	Returns the threshold value of this queue, -1 if not set.
`int`	`getWaitingRequestCount()`	Returns the number of waiting requests in the queue.
`boolean`	`isPause()`
`void`	`setDeliveryDelay(int deliveryDelay)`	Sets the Queue deliveryDelay in milliseconds.
`void`	`setNbMaxMsg(int nbMaxMsg)`	Sets the maximum number of message for the destination.
`void`	`setPause(boolean pause)`
`void`	`setRedeliveryDelay(int reDeliveryDelay)`
`void`	`setThreshold(int threshold)`	Sets or unsets the threshold for this queue.

Methods inherited from interface fr.dyade.aaa.agent.AgentMBean
getAgentId, getCommitTime, getReactNb, getReactTime, isAgentProfiling, isFixed, resetCommitTime, resetReactTime, resetTimer, setAgentProfiling

Methods inherited from interface org.objectweb.joram.mom.dest.DestinationMBean
delete, getCreationDate, getCreationTimeInMillis, getDestinationId, getDMQId, getName, getNbMsgsDeliverSinceCreation, getNbMsgsReceiveSinceCreation, getNbMsgsSentToDMQSinceCreation, getPeriod, getRight, getRights, getType, isFreeReading, isFreeWriting, setFreeReading, setFreeWriting, setPeriod, toString

- Method Detail
  - getThreshold
```
int getThreshold()
```
    Returns the threshold value of this queue, -1 if not set.
    
    Returns:
    
    the threshold value of this queue; -1 if not set.
  - setThreshold
```
void setThreshold(int threshold)
```
    Sets or unsets the threshold for this queue.
    
    Parameters:
    
    threshold - The threshold value to be set or -1 for unsetting previous value.
  - getWaitingRequestCount
```
int getWaitingRequestCount()
```
    Returns the number of waiting requests in the queue.
    
    Returns:
    
    The number of waiting requests.
  - cleanWaitingRequest
```
void cleanWaitingRequest()
                  throws Exception
```
    Removes all request that the expiration time is expired.
    
    Throws:
    
    Exception
  - getPendingMessageCount
```
int getPendingMessageCount()
```
    Returns the number of pending messages in the queue.
    
    Returns:
    
    The number of pending messages.
  - getDelayedMessageCount
```
int getDelayedMessageCount()
```
    Returns the number of messages waiting for a delay.
    
    Returns:
    
    The number of messages waiting for a delay.
  - getProducerLoad
```
long getProducerLoad()
```
    Return the average producer's load during last moments.
  - getConsumerLoad
```
long getConsumerLoad()
```
    Return the average consumer's load during last moments.
  - cleanPendingMessage
```
void cleanPendingMessage()
                  throws Exception
```
    Removes all messages that the time-to-live is expired.
    
    Throws:
    
    Exception
  - getDeliveredMessageCount
```
int getDeliveredMessageCount()
```
    Returns the number of messages delivered and waiting for acknowledge.
    
    Returns:
    
    The number of messages delivered.
  - getNbMsgsDeniedSinceCreation
```
long getNbMsgsDeniedSinceCreation()
```
    Returns the number of messages denied since creation time of this destination.
    
    Returns:
    
    the number of messages delivered since creation time.
  - getNbMaxMsg
```
int getNbMaxMsg()
```
    Returns the maximum number of message for the destination. If the limit is unset the method returns -1.
    
    Returns:
    
    the maximum number of message for subscription if set; -1 otherwise.
  - setNbMaxMsg
```
void setNbMaxMsg(int nbMaxMsg)
```
    Sets the maximum number of message for the destination.
    
    Parameters:
    
    nbMaxMsg - the maximum number of message (-1 set no limit).
  - getMessage
```
CompositeData getMessage(String msgId)
                  throws Exception
```
    Returns the description of a particular pending message. The message is pointed out through its unique identifier.
    
    Parameters:
    
    msgId - The unique message's identifier.
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getMessages
```
TabularData getMessages()
                 throws Exception
```
    Returns the description of all pending messages.
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getDelayedMessage
```
CompositeData getDelayedMessage(String msgId)
                         throws Exception
```
    Returns the description of a particular delayed message. The message is pointed out through its unique identifier.
    
    Parameters:
    
    msgId - The unique message's identifier.
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getDelayedMessages
```
TabularData getDelayedMessages()
                        throws Exception
```
    Returns the description of all delayed messages.
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getRedeliveryDelay
```
int getRedeliveryDelay()
```
    Return the reDeliveryDelay (unit: second)
  - setRedeliveryDelay
```
void setRedeliveryDelay(int reDeliveryDelay)
```
    Parameters:
    
    reDeliveryDelay - the reDeliveryDelay to set(unit: second)
  - getDeliveryDelay
```
int getDeliveryDelay()
```
    Returns the Queue deliveryDelay in milliseconds.
    
    Returns:
    
    the DeliveryDelay
  - setDeliveryDelay
```
void setDeliveryDelay(int deliveryDelay)
```
    Sets the Queue deliveryDelay in milliseconds.
    
    Parameters:
    
    deliveryDelay - the deliveryDelay to set
  - isPause
```
boolean isPause()
```
  - setPause
```
void setPause(boolean pause)
```
  - exportMessages
```
void exportMessages(String dirpath,
                    String selector,
                    boolean quiet)
             throws Exception
```
    Exports all messages in the specified directory. Options? filtrage? Format?
    
    Throws:
    
    Exception
  - clear
```
void clear()
```
    Removes all pending messages.

Interface QueueMBean

Method Summary

Methods inherited from interface fr.dyade.aaa.agent.AgentMBean

Methods inherited from interface org.objectweb.joram.mom.dest.DestinationMBean

Method Detail

getThreshold

setThreshold

getWaitingRequestCount

cleanWaitingRequest

getPendingMessageCount

getDelayedMessageCount

getProducerLoad

getConsumerLoad

cleanPendingMessage

getDeliveredMessageCount

getNbMsgsDeniedSinceCreation

getNbMaxMsg

setNbMaxMsg

getMessage

getMessages

getDelayedMessage

getDelayedMessages

getRedeliveryDelay

setRedeliveryDelay

getDeliveryDelay

setDeliveryDelay

isPause

setPause

exportMessages

clear