java.lang.Object
- fr.dyade.aaa.agent.Agent
- - org.objectweb.joram.mom.dest.Destination
  - - org.objectweb.joram.mom.dest.Queue

All Implemented Interfaces:

AgentMBean, Encodable, Serializable, DestinationMBean, QueueMBean

Direct Known Subclasses:

AcquisitionQueue, AliasInQueue, AliasQueue, ClusterQueue, DistributionQueue, FtpQueue, SchedulerQueue
```
public class Queue
extends Destination
implements QueueMBean
```
The Queue class implements the MOM queue behavior, basically storing messages and delivering them upon clients requests.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Queue.QueueFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ARRIVAL_STATE_PREFIX`
`protected QueueArrivalState`	`arrivalState`	Counter of messages arrivals.
`(package private) int`	`cload`
`private static boolean`	`DEBUG`
`(package private) static AgentId`	`defaultDMQId`	Static value holding the default DMQ identifier for a server.
`(package private) static int`	`defaultRedeliveryDelay`	Static value holding the default redelivery delay for a server.
`(package private) static int`	`defaultThreshold`	Static value holding the default threshold for a server.
`protected List<Message>`	`delayed`	List of delayed messages
`static String`	`DELIVERY_TABLE_PREFIX`
`static String`	`DELIVERY_TIMEOUT`	Property preventing unacceptable delivery times when a selector processes excessively long queues.
`private int`	`deliveryDelay`	The delivery delay in milliseconds used to wait before delivering a message.
`protected QueueDeliveryTable`	`deliveryTable`	Table keeping the message deliveries
`private long`	`deliveryTimeout`
`private long`	`DFLT_DELIVERY_TIMEOUT`
`(package private) long`	`hcons`
`(package private) long`	`hprod`
`static String`	`LENIENT_REDELIVERY_DELAY`	Property allowing to delay the denied messages even if there are not considered 'redelivered' (see JMS specification).
`static String`	`LENIENT_UNDELIVERABLE`	Property allowing to handle 'denied' messages as if they were considered 'redelivered' (see JMS specification).
`private boolean`	`lenientRedeliveryDelay`
`private boolean`	`lenientUndeliverable`
`private static Logger`	`logger`
`(package private) static Logger`	`logmsg`
`protected List<Message>`	`messages`	List holding the messages before delivery.
`(package private) StringBuffer`	`msgTxPrefix`
`(package private) int`	`msgTxPrefixLength`
`protected int`	`nbExpirations`	Number of stored messages with an expiration date.
`protected int`	`nbMaxMsg`	nb Max of Message store in queue (-1 no limit).
`protected long`	`nbMsgsDeniedSinceCreation`
`private boolean`	`pause`
`(package private) int`	`pload`
`private int`	`priority`	Common priority value.
`protected boolean`	`receiving`	`true` if the queue is currently handling a new received message.
`private int`	`redeliveryDelay`	The re-delivery delay in seconds use to wait before re-delivering messages after a deny.
`protected List<ReceiveRequest>`	`requests`	List holding the requests before reply or expiry.
`private boolean`	`samePriorities`	`true` if all the stored messages have the same priority.
`private static long`	`serialVersionUID`	define serialVersionUID for interoperability
`private boolean`	`syncExceptionOnFullDest`	if true, throws an exception on sending message on full destination.
`private int`	`threshold`	Threshold above which messages are considered as undeliverable because constantly denied; 0 stands for no threshold, -1 for value not set.

Fields inherited from class org.objectweb.joram.mom.dest.Destination
clients, dmqId, freeReading, freeWriting, nbMsgsDeliverSinceCreation, nbMsgsSentToDMQSinceCreation, READ, READWRITE, strbuf, strictCounters, task, temporary, WRITE

Fields inherited from class fr.dyade.aaa.agent.Agent
agentProfiling, emptyString, fixed, logmon

Fields inherited from interface fr.dyade.aaa.common.encoding.Encodable
BOOLEAN_ENCODED_SIZE, BYTE_ENCODED_SIZE, DOUBLE_ENCODED_SIZE, FLOAT_ENCODED_SIZE, INT_ENCODED_SIZE, LONG_ENCODED_SIZE, SHORT_ENCODED_SIZE

Constructor Summary

Constructors
Modifier Constructor Description

Queue()
Creates a queue.

protected Queue(String name, boolean fixed, int stamp)
Creates a queue with a specified stamp.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`abortReceiveRequest(AgentId from, AbortReceiveRequest not)`
`private void`	`acknowledge(String msgId)`
`protected void`	`acknowledgeRequest(AcknowledgeRequest not)`	Method implementing the reaction to an `AcknowledgeRequest` instance, requesting messages to be acknowledged.
`void`	`addClientMessages(ClientMessages clientMsgs, boolean throwsExceptionOnFullDest)`	Adds the client messages in the queue.
`(package private) void`	`addDeliveryTimeMessage(Message msg, boolean throwsExceptionOnFullDest, boolean isHeader)`	Adds the specified message to the list of delayed message.
`protected boolean`	`addMessage(Message message, boolean throwsExceptionOnFullDest)`	Adds a message in the list of messages to deliver.
`protected void`	`agentSave()`	Enables the sub-classes to save their state.
`protected void`	`browseRequest(AgentId from, BrowseRequest not)`	Method implementing the queue reaction to a `BrowseRequest` instance, requesting an enumeration of the messages on the queue.
`protected boolean`	`checkDelivery(Message msg)`	Returns true if conditions are ok to deliver the message.
`void`	`cleanPendingMessage()`	Removes all messages that the time-to-live is expired.
`protected DMQManager`	`cleanPendingMessage(long currentTime)`	Cleans the pending messages list.
`void`	`cleanWaitingRequest()`	Removes all request that the expiration time is expired.
`protected void`	`cleanWaitingRequest(long currentTime)`	Cleans the waiting request list.
`void`	`clear()`	Removes all pending messages.
`private void`	`clearQueue(AgentId replyTo, String requestMsgId, String replyMsgId)`
`void`	`decode(Decoder decoder)`	Decodes the object.
`private void`	`deleteQueueMessage(DeleteQueueMessage request, AgentId replyTo, String requestMsgId, String replyMsgId)`
`protected void`	`deliverMessages(int index)`	Actually tries to answer the pending "receive" requests.
`private DMQManager`	`denyMessage(String msgid, boolean redelivered, DMQManager dmqManager)`	Denies the specified message.
`protected void`	`denyRequest(AgentId from, DenyRequest not)`	Method implementing the reaction to a `DenyRequest` instance, requesting messages to be denied.
`protected void`	`doAdminSyncNotification(AgentId from, AdminSyncNotification not)`	Handling of AdminSyncNotification.
`protected void`	`doClientMessages(AgentId from, ClientMessages not, boolean throwsExceptionOnFullDest)`	Method specifically processing a `ClientMessages` instance.
`protected void`	`doDeleteNot(DeleteNot not)`	Method specifically processing a `fr.dyade.aaa.agent.DeleteNot` instance.
`private void`	`doExportMessages(String dirpath, String selector, boolean binary)`	Exports all messages in the specified directory.
`protected void`	`doRightRequest(AgentId user, int right)`	Method specifically processing a `SetRightRequest` instance.
`protected void`	`doUnknownAgent(UnknownAgent uA)`	Method specifically processing an `UnknownAgent` instance.
`void`	`encode(Encoder encoder)`	Encodes the object.
`void`	`exportMessages(String dirpath, String selector, boolean binary)`	Exports all messages in the specified directory.
`protected void`	`finalize(boolean last)`	Finalizes the destination before it is garbaged.
`protected ClientMessages`	`getClientMessages(int nb, String selector, boolean remove)`	Get a client message contain `nb` messages.
`long`	`getConsumerLoad()`	Return the average consumer's load during last moments.
`static AgentId`	`getDefaultDMQId()`	Static method returning the default DMQ identifier.
`static int`	`getDefaultRedeliveryDelay()`	Static method returning the default redelivery delay for a server.
`static int`	`getDefaultThreshold()`	Static method returning the default threshold.
`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 pending messages.
`int`	`getDeliveredMessageCount()`	Returns the number of messages delivered and waiting for acknowledge.
`int`	`getDeliveryDelay()`	Returns the Queue deliveryDelay in milliseconds.
`int`	`getEncodableClassId()`	Enables the sub classes not to implement this method.
`int`	`getEncodedSize()`	Returns the size of the encoded object.
`private static String`	`getIdString(Message msg)`
`CompositeData`	`getMessage(String msgId)`	Returns the description of a particular pending message.
`TabularData`	`getMessages()`	Returns the description of all pending messages.
`private List<Message>`	`getMessages(int nb, String selector, boolean remove)`	get messages, if it's possible.
`List<? extends MessageView>`	`getMessagesView()`	Only used from shell-mom MOMCommandsImpl.
`private Message`	`getMomMessage(String msgId)`
`protected StringBuffer`	`getMsgTxPrefix()`
`int`	`getNbMaxMsg()`	Returns the maximum number of message for the destination.
`long`	`getNbMsgsDeliverSinceCreation()`	Returns the number of messages delivered since creation time of this destination.
`long`	`getNbMsgsDeniedSinceCreation()`	Returns the number of messages denied since creation time of this destination.
`long`	`getNbMsgsReceiveSinceCreation()`	Returns the number of messages received 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.
`protected Message`	`getQueueMessage(String msgId, boolean remove)`	Get mom message, delete if remove = true.
`private void`	`getQueueMessage(GetQueueMessage request, AgentId replyTo, String requestMsgId, String replyMsgId)`
`private void`	`getQueueMessageIds(AgentId replyTo, String requestMsgId, String replyMsgId)`
`int`	`getRedeliveryDelay()`	Returns the delay in seconds use to wait before re-delivering messages after a deny.
`protected Properties`	`getStats()`
`int`	`getThreshold()`	Returns the threshold value of this queue, -1 if not set.
`byte`	`getType()`	Returns the type of this destination: Queue or Topic.
`int`	`getWaitingRequestCount()`	Returns the number of waiting requests in the queue.
`void`	`handleAdminRequestNot(AgentId from, FwdAdminRequestNot not)`
`protected void`	`handleExpiredNot(AgentId from, ExpiredNot not)`
`protected void`	`initialize(boolean firstTime)`	Initializes the destination.
`boolean`	`isPause()`
`boolean`	`isSyncExceptionOnFullDest()`
`protected boolean`	`isUndeliverable(Message message)`	Returns `true` if a given message is considered as undeliverable, because its delivery count matches the queue's threshold, if any, or the server's default threshold value (if any).
`protected boolean`	`isValidJMXAttribute(String attrName)`	This method allows to exclude some JMX attribute of getJMXStatistics method.
`private void`	`logmsg(Level loggerLevel, Level logmsgLevel, String logMessage)`	Logs message either in logmsg if configured, or in logger.
`protected void`	`messageDelivered(String msgId)`	call in deliverMessages just after forward(msg), overload this method to process a specific treatment.
`protected void`	`messageRemoved(String msgId)`	call in deliverMessages just after a remove message (invalid), overload this method to process a specific treatment.
`(package private) void`	`processDeliveryTime(AgentId from, QueueDeliveryTimeNot not)`
`void`	`react(AgentId from, Notification not)`	Distributes the received notifications to the appropriate reactions.
`protected void`	`receiveRequest(AgentId from, ReceiveRequest not)`	Method implementing the reaction to a `ReceiveRequest` instance, requesting a message.
`static void`	`setDefaultRedeliveryDelay(int reDeliveryDelay)`
`void`	`setDeliveryDelay(int deliveryDelay)`	Sets the Queue deliveryDelay in milliseconds.
`protected void`	`setMsgTxName(Message msg)`
`void`	`setNbMaxMsg(int nbMaxMsg)`	Sets the maximum number of message for the destination.
`void`	`setPause(boolean pause)`
`void`	`setProperties(Properties properties, boolean firstTime)`	Configures an `Queue` instance.
`void`	`setRedeliveryDelay(int redeliveryDelay)`	Sets the delay in seconds use to wait before re-delivering messages after a deny.
`void`	`setSyncExceptionOnFullDest(boolean syncExceptionOnFullDest)`
`void`	`setThreshold(int threshold)`	Sets or unsets the threshold for this queue.
`protected void`	`storeMessage(Message msg, boolean throwsExceptionOnFullDest)`	Actually stores a message in the deliverables list.
`String`	`toString()`	Returns a string representation of this destination.
`void`	`wakeUpNot(WakeUpNot not)`	wake up, and cleans the queue.

Methods inherited from class org.objectweb.joram.mom.dest.Destination
agentFinalize, agentInitialize, clientMessages, delete, deleteNot, forward, getCreationDate, getCreationTimeInMillis, getDestinationId, getDMQAgentId, getDMQId, getJMXStatistics, getNbMsgsSentToDMQSinceCreation, getPeriod, getRight, getRights, getRights, handleDeniedMessage, interceptorsAvailable, isAdministrator, isFreeReading, isFreeWriting, isLocal, isReader, isWriter, postProcess, preProcess, processAdminCommand, processInterceptors, processPause, processSetRight, processStartHandler, processStopHandler, replyToTopic, requestGroupNot, setAdminId, setFreeReading, setFreeWriting, setPeriod, setRight, unknownAgent

Methods inherited from class fr.dyade.aaa.agent.Agent
delete, delete, deploy, deploy, getAgentId, getCommitTime, getId, getLogTopic, getName, getReactNb, getReactTime, hasName, incWorkInProgress, isAgentProfiling, isDeployed, isFixed, isUpdated, load, needToBeCommited, resetCommitTime, resetReactTime, resetTimer, save, sendTo, sendTo, sendTo, setAgentProfiling, setName, setNoSave, setSave

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getNbMsgsSentToDMQSinceCreation, getPeriod, getRight, getRights, isFreeReading, isFreeWriting, setFreeReading, setFreeWriting, setPeriod

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    define serialVersionUID for interoperability
    
    See Also:
    
    Constant Field Values
  - logger
```
private static final Logger logger
```
  - DEBUG
```
private static final boolean DEBUG
```
  - logmsg
```
static final Logger logmsg
```
  - DELIVERY_TABLE_PREFIX
```
public static final String DELIVERY_TABLE_PREFIX
```
    See Also:
    
    Constant Field Values
  - ARRIVAL_STATE_PREFIX
```
public static final String ARRIVAL_STATE_PREFIX
```
    See Also:
    
    Constant Field Values
  - defaultDMQId
```
static AgentId defaultDMQId
```
    Static value holding the default DMQ identifier for a server.
  - LENIENT_REDELIVERY_DELAY
```
public static final String LENIENT_REDELIVERY_DELAY
```
    Property allowing to delay the denied messages even if there are not considered 'redelivered' (see JMS specification). Normally, a message is considered 'redelivered' only if it has been delivered and rejected by the client. So, Messages 'denied' due to an error in the delivery mechanism are immediately re-delivered. The default value is false.
    
    See Also:
    
    Constant Field Values
  - lenientRedeliveryDelay
```
private boolean lenientRedeliveryDelay
```
  - LENIENT_UNDELIVERABLE
```
public static final String LENIENT_UNDELIVERABLE
```
    Property allowing to handle 'denied' messages as if they were considered 'redelivered' (see JMS specification). Normally, a message is considered 'redelivered' only if it has been delivered and rejected by the client, in this case its delivery counter is incremented. Then, a message is handled as 'undeliverable' only if it has been delivered and rejected several times by the client (the maximum number of attempts is defined by the queue's 'threshold' property). This property allows to increment the message delivery counter even when the message has been 'denied' due to an error in the delivery mechanism. The default value is false.
    
    See Also:
    
    Constant Field Values
  - lenientUndeliverable
```
private boolean lenientUndeliverable
```
  - DELIVERY_TIMEOUT
```
public static final String DELIVERY_TIMEOUT
```
    Property preventing unacceptable delivery times when a selector processes excessively long queues. If the time taken to retrieve a message from the queue exceeds the allotted time, the queue returns null, as if no message satisfied the query. If the timeout is negative, the queue is infinite. The default value is -1.
    
    See Also:
    
    Constant Field Values
  - DFLT_DELIVERY_TIMEOUT
```
private long DFLT_DELIVERY_TIMEOUT
```
  - deliveryTimeout
```
private long deliveryTimeout
```
  - threshold
```
private int threshold
```
    Threshold above which messages are considered as undeliverable because constantly denied; 0 stands for no threshold, -1 for value not set.
  - defaultThreshold
```
static int defaultThreshold
```
    Static value holding the default threshold for a server.
  - redeliveryDelay
```
private int redeliveryDelay
```
    The re-delivery delay in seconds use to wait before re-delivering messages after a deny.
  - defaultRedeliveryDelay
```
static int defaultRedeliveryDelay
```
    Static value holding the default redelivery delay for a server.
  - deliveryDelay
```
private int deliveryDelay
```
    The delivery delay in milliseconds used to wait before delivering a message. If set the resulting delay is the max between this value and the message property.
  - pause
```
private boolean pause
```
  - samePriorities
```
private boolean samePriorities
```
    true if all the stored messages have the same priority. Note: messages list is ordered by priorities, so we could test if first and last message have the same priority.
  - nbExpirations
```
protected int nbExpirations
```
    Number of stored messages with an expiration date.
  - priority
```
private int priority
```
    Common priority value.
  - deliveryTable
```
protected transient QueueDeliveryTable deliveryTable
```
    Table keeping the message deliveries
  - arrivalState
```
protected transient QueueArrivalState arrivalState
```
    Counter of messages arrivals.
  - requests
```
protected List<ReceiveRequest> requests
```
    List holding the requests before reply or expiry.
  - receiving
```
protected transient boolean receiving
```
    true if the queue is currently handling a new received message.
  - messages
```
protected transient List<Message> messages
```
    List holding the messages before delivery.
  - delayed
```
protected transient List<Message> delayed
```
    List of delayed messages
  - nbMsgsDeniedSinceCreation
```
protected long nbMsgsDeniedSinceCreation
```
  - nbMaxMsg
```
protected int nbMaxMsg
```
    nb Max of Message store in queue (-1 no limit).
  - hprod
```
long hprod
```
  - hcons
```
long hcons
```
  - pload
```
int pload
```
  - cload
```
int cload
```
  - msgTxPrefix
```
transient StringBuffer msgTxPrefix
```
  - msgTxPrefixLength
```
transient int msgTxPrefixLength
```
  - syncExceptionOnFullDest
```
private boolean syncExceptionOnFullDest
```
    if true, throws an exception on sending message on full destination.
- Constructor Detail
  - Queue
```
public Queue()
```
    Creates a queue.
  - Queue
```
protected Queue(String name,
                boolean fixed,
                int stamp)
```
    Creates a queue with a specified stamp. It is used by the Encodable framework as the default constructor allocates a new stamp.
    
    Parameters:
    
    name - Name of topic;
    
    fixed - If true, topic is fixed in memory.
    
    stamp - Specific stamp for resulting agent.
- Method Detail
  - getThreshold
```
public int getThreshold()
```
    Returns the threshold value of this queue, -1 if not set.
    
    Specified by:
    
    getThreshold in interface QueueMBean
    
    Returns:
    
    the threshold value of this queue; -1 if not set.
  - setThreshold
```
public void setThreshold(int threshold)
```
    Sets or unsets the threshold for this queue.
    
    Specified by:
    
    setThreshold in interface QueueMBean
    
    Parameters:
    
    threshold - The threshold value to be set (-1 for unsetting previous value).
  - getDefaultThreshold
```
public static int getDefaultThreshold()
```
    Static method returning the default threshold.
  - getDefaultDMQId
```
public static AgentId getDefaultDMQId()
```
    Static method returning the default DMQ identifier.
  - getRedeliveryDelay
```
public final int getRedeliveryDelay()
```
    Returns the delay in seconds use to wait before re-delivering messages after a deny.
    
    Specified by:
    
    getRedeliveryDelay in interface QueueMBean
    
    Returns:
    
    the reDeliveryDelay
  - setRedeliveryDelay
```
public final void setRedeliveryDelay(int redeliveryDelay)
```
    Sets the delay in seconds use to wait before re-delivering messages after a deny.
    
    Specified by:
    
    setRedeliveryDelay in interface QueueMBean
    
    Parameters:
    
    redeliveryDelay - the reDeliveryDelay to set
  - getDefaultRedeliveryDelay
```
public static final int getDefaultRedeliveryDelay()
```
    Static method returning the default redelivery delay for a server.
  - setDefaultRedeliveryDelay
```
public static final void setDefaultRedeliveryDelay(int reDeliveryDelay)
```
  - getDeliveryDelay
```
public final int getDeliveryDelay()
```
    Returns the Queue deliveryDelay in milliseconds.
    
    Specified by:
    
    getDeliveryDelay in interface QueueMBean
    
    Returns:
    
    the DeliveryDelay
  - setDeliveryDelay
```
public final void setDeliveryDelay(int deliveryDelay)
```
    Sets the Queue deliveryDelay in milliseconds.
    
    Specified by:
    
    setDeliveryDelay in interface QueueMBean
    
    Parameters:
    
    deliveryDelay - the deliveryDelay to set
  - isPause
```
public boolean isPause()
```
    Specified by:
    
    isPause in interface QueueMBean
  - setPause
```
public void setPause(boolean pause)
```
    Specified by:
    
    setPause in interface QueueMBean
  - setProperties
```
public void setProperties(Properties properties,
                          boolean firstTime)
                   throws Exception
```
    Configures an Queue instance.
    
    Overrides:
    
    setProperties in class Destination
    
    Parameters:
    
    properties - The initial set of properties.
    
    Throws:
    
    Exception
  - react
```
public void react(AgentId from,
                  Notification not)
           throws Exception
```
    Distributes the received notifications to the appropriate reactions.
    
    Overrides:
    
    react in class Destination
    
    Parameters:
    
    from - agent sending notification
    
    not - notification to react to
    
    Throws:
    
    Exception
  - agentSave
```
protected void agentSave()
                  throws IOException
```
    Description copied from class: Agent
    
    Enables the sub-classes to save their state.
    
    Overrides:
    
    agentSave in class Agent
    
    Throws:
    
    IOException - if any error occurs.
  - cleanWaitingRequest
```
public final void cleanWaitingRequest()
                               throws Exception
```
    Removes all request that the expiration time is expired. Be careful,this method is part of the Queue MBean interface, it can be called outside the reactions of the engine thread. In order to avoid synchronization issues we should avoid direct manipulation of requests list (see JORAM-372, JORAM-373).
    
    Specified by:
    
    cleanWaitingRequest in interface QueueMBean
    
    Throws:
    
    Exception
    
    InterruptedException
  - cleanWaitingRequest
```
protected void cleanWaitingRequest(long currentTime)
```
    Cleans the waiting request list. Removes all request that the expiration time is less than the time given in parameter.
    
    Parameters:
    
    currentTime - The current time.
  - getWaitingRequestCount
```
public final int getWaitingRequestCount()
```
    Returns the number of waiting requests in the queue.
    
    Specified by:
    
    getWaitingRequestCount in interface QueueMBean
    
    Returns:
    
    The number of waiting requests.
  - getDelayedMessageCount
```
public final int getDelayedMessageCount()
```
    Returns the number of messages waiting for a delay.
    
    Specified by:
    
    getDelayedMessageCount in interface QueueMBean
    
    Returns:
    
    The number of messages waiting for a delay.
  - getType
```
public byte getType()
```
    Description copied from class: Destination
    
    Returns the type of this destination: Queue or Topic.
    
    Specified by:
    
    getType in interface DestinationMBean
    
    Specified by:
    
    getType in class Destination
    
    Returns:
    
    the type of this destination.
    
    See Also:
    
    DestinationConstants.TOPIC_TYPE, DestinationConstants.QUEUE_TYPE, DestinationConstants.TEMPORARY
  - cleanPendingMessage
```
public final void cleanPendingMessage()
                               throws Exception
```
    Removes all messages that the time-to-live is expired. Be careful,this method is part of the Queue MBean interface, it can be called outside the reactions of the engine thread. In order to avoid synchronization issues we should avoid direct manipulation of messages list (see JORAM-372, JORAM-373).
    
    Specified by:
    
    cleanPendingMessage in interface QueueMBean
    
    Throws:
    
    Exception
    
    InterruptedException
  - cleanPendingMessage
```
protected DMQManager cleanPendingMessage(long currentTime)
```
    Cleans the pending messages list. Removes all messages which expire before the date given in parameter.
    
    Parameters:
    
    currentTime - The current time.
    
    Returns:
    
    A DMQManager which contains the expired messages. null if there wasn't any.
  - getPendingMessageCount
```
public final int getPendingMessageCount()
```
    Returns the number of pending messages in the queue.
    
    Specified by:
    
    getPendingMessageCount in interface QueueMBean
    
    Returns:
    
    The number of pending messages.
  - getDeliveredMessageCount
```
public final int getDeliveredMessageCount()
```
    Returns the number of messages delivered and waiting for acknowledge.
    
    Specified by:
    
    getDeliveredMessageCount in interface QueueMBean
    
    Returns:
    
    The number of messages delivered.
  - getNbMsgsDeniedSinceCreation
```
public final long getNbMsgsDeniedSinceCreation()
```
    Returns the number of messages denied since creation time of this destination.
    
    Specified by:
    
    getNbMsgsDeniedSinceCreation in interface QueueMBean
    
    Returns:
    
    the number of messages delivered since creation time.
  - getNbMsgsDeliverSinceCreation
```
public long getNbMsgsDeliverSinceCreation()
```
    Description copied from class: Destination
    
    Returns the number of messages delivered since creation time of this destination. It includes messages all delivered messages to a consumer, already acknowledged or not.
    
    Specified by:
    
    getNbMsgsDeliverSinceCreation in interface DestinationMBean
    
    Overrides:
    
    getNbMsgsDeliverSinceCreation in class Destination
    
    Returns:
    
    the number of messages delivered since creation time.
  - getNbMsgsReceiveSinceCreation
```
public long getNbMsgsReceiveSinceCreation()
```
    Description copied from class: Destination
    
    Returns the number of messages received since creation time of this destination.
    
    Specified by:
    
    getNbMsgsReceiveSinceCreation in interface DestinationMBean
    
    Specified by:
    
    getNbMsgsReceiveSinceCreation in class Destination
    
    Returns:
    
    the number of messages received since creation time.
  - getNbMaxMsg
```
public final int getNbMaxMsg()
```
    Returns the maximum number of message for the destination. If the limit is unset the method returns -1.
    
    Specified by:
    
    getNbMaxMsg in interface QueueMBean
    
    Returns:
    
    the maximum number of message for subscription if set; -1 otherwise.
  - setNbMaxMsg
```
public void setNbMaxMsg(int nbMaxMsg)
```
    Sets the maximum number of message for the destination.
    
    Specified by:
    
    setNbMaxMsg in interface QueueMBean
    
    Parameters:
    
    nbMaxMsg - the maximum number of message (-1 set no limit).
  - initialize
```
protected void initialize(boolean firstTime)
                   throws Exception
```
    Initializes the destination.
    
    Specified by:
    
    initialize in class Destination
    
    Parameters:
    
    firstTime - true when first called by the factory
    
    Throws:
    
    Exception
  - finalize
```
protected void finalize(boolean last)
```
    Finalizes the destination before it is garbaged.
    
    Specified by:
    
    finalize in class Destination
    
    Parameters:
    
    last - true if the destination is deleted
  - toString
```
public String toString()
```
    Returns a string representation of this destination.
    
    Specified by:
    
    toString in interface AgentMBean
    
    Specified by:
    
    toString in interface DestinationMBean
    
    Overrides:
    
    toString in class Agent
    
    Returns:
    
    a string representation of this destination.
  - wakeUpNot
```
public void wakeUpNot(WakeUpNot not)
```
    wake up, and cleans the queue.
    
    Specified by:
    
    wakeUpNot in class Destination
  - getProducerLoad
```
public long getProducerLoad()
```
    Return the average producer's load during last moments.
    
    Specified by:
    
    getProducerLoad in interface QueueMBean
  - getConsumerLoad
```
public long getConsumerLoad()
```
    Return the average consumer's load during last moments.
    
    Specified by:
    
    getConsumerLoad in interface QueueMBean
  - isValidJMXAttribute
```
protected boolean isValidJMXAttribute(String attrName)
```
    This method allows to exclude some JMX attribute of getJMXStatistics method. It excludes.
    
    Overrides:
    
    isValidJMXAttribute in class Destination
    
    Parameters:
    
    attrName - name of attribute to test.
    
    Returns:
    
    true if the attribute is a valid one.
  - receiveRequest
```
protected void receiveRequest(AgentId from,
                              ReceiveRequest not)
                       throws AccessException
```
    Method implementing the reaction to a ReceiveRequest instance, requesting a message.
    This method stores the request and launches a delivery sequence.
    
    Throws:
    
    AccessException - If the sender is not a reader.
  - browseRequest
```
protected void browseRequest(AgentId from,
                             BrowseRequest not)
                      throws AccessException
```
    Method implementing the queue reaction to a BrowseRequest instance, requesting an enumeration of the messages on the queue.
    The method sends a BrowseReply back to the client. Expired messages are sent to the DMQ.
    
    Throws:
    
    AccessException - If the requester is not a reader.
  - acknowledgeRequest
```
protected void acknowledgeRequest(AcknowledgeRequest not)
```
    Method implementing the reaction to an AcknowledgeRequest instance, requesting messages to be acknowledged.
  - acknowledge
```
private void acknowledge(String msgId)
```
  - denyRequest
```
protected void denyRequest(AgentId from,
                           DenyRequest not)
```
    Method implementing the reaction to a DenyRequest instance, requesting messages to be denied.
    This method denies the messages and launches a delivery sequence. Messages considered as undeliverable are sent to the DMQ.
  - denyMessage
```
private DMQManager denyMessage(String msgid,
                               boolean redelivered,
                               DMQManager dmqManager)
```
    Denies the specified message.
    
    Parameters:
    
    msgid - The identifier of message to deny.
    
    redelivered - True if the message has been denied from user.
    
    dmqManager - The DMQManager if it exists, null otherwise.
    
    Returns:
    
    The DMQManager if it exists, null otherwise.
  - logmsg
```
private void logmsg(Level loggerLevel,
                    Level logmsgLevel,
                    String logMessage)
```
    Logs message either in logmsg if configured, or in logger.
    
    Parameters:
    
    loggerLevel -
    
    logmsgLevel -
    
    logMessage -
  - abortReceiveRequest
```
protected void abortReceiveRequest(AgentId from,
                                   AbortReceiveRequest not)
```
  - handleAdminRequestNot
```
public void handleAdminRequestNot(AgentId from,
                                  FwdAdminRequestNot not)
```
    Overrides:
    
    handleAdminRequestNot in class Destination
    
    See Also:
    
    Destination.handleAdminRequestNot(fr.dyade.aaa.agent.AgentId, org.objectweb.joram.mom.notifications.FwdAdminRequestNot)
  - getQueueMessageIds
```
private void getQueueMessageIds(AgentId replyTo,
                                String requestMsgId,
                                String replyMsgId)
```
  - getQueueMessage
```
private void getQueueMessage(GetQueueMessage request,
                             AgentId replyTo,
                             String requestMsgId,
                             String replyMsgId)
```
  - deleteQueueMessage
```
private void deleteQueueMessage(DeleteQueueMessage request,
                                AgentId replyTo,
                                String requestMsgId,
                                String replyMsgId)
```
  - clear
```
public void clear()
```
    Removes all pending messages.
    
    Specified by:
    
    clear in interface QueueMBean
  - clearQueue
```
private void clearQueue(AgentId replyTo,
                        String requestMsgId,
                        String replyMsgId)
```
  - doRightRequest
```
protected void doRightRequest(AgentId user,
                              int right)
```
    Method specifically processing a SetRightRequest instance.
    When a reader is removed, and receive requests of this reader are still on the queue, they are replied to by an ExceptionReply.
    
    Specified by:
    
    doRightRequest in class Destination
    
    Parameters:
    
    user - The user about right modification.
    
    right - The right modification.
  - doClientMessages
```
protected void doClientMessages(AgentId from,
                                ClientMessages not,
                                boolean throwsExceptionOnFullDest)
                         throws AccessException
```
    Method specifically processing a ClientMessages instance.
    This method stores the messages and launches a delivery sequence. This method is used when ClientMessages comes from a JMS client and/or LB notification in ClusterQueue (May be we should use addClienMessages). It is also used in old deprecated JMS bridge.
    
    Specified by:
    
    doClientMessages in class Destination
    
    Throws:
    
    AccessException
  - getIdString
```
private static final String getIdString(Message msg)
```
  - addDeliveryTimeMessage
```
void addDeliveryTimeMessage(Message msg,
                            boolean throwsExceptionOnFullDest,
                            boolean isHeader)
                     throws AccessException
```
    Adds the specified message to the list of delayed message.
    
    Parameters:
    
    msg - The message to add.
    
    throwsExceptionOnFullDest - if true, can throws an exception if destination is full.
    
    isHeader - If true, only save the message header (the message has already been saved).
    
    Throws:
    
    AccessException
  - processDeliveryTime
```
void processDeliveryTime(AgentId from,
                         QueueDeliveryTimeNot not)
                  throws AccessException
```
    Throws:
    
    AccessException
  - doUnknownAgent
```
protected void doUnknownAgent(UnknownAgent uA)
```
    Method specifically processing an UnknownAgent instance.
    The specific processing is done when a QueueMsgReply was sent to a requester which does not exist anymore. In that case, the messages sent to this requester and not yet acknowledged are marked as "denied" for delivery to an other requester, and a new delivery sequence is launched. Messages considered as undeliverable are removed and sent to the DMQ.
    
    Specified by:
    
    doUnknownAgent in class Destination
  - doDeleteNot
```
protected void doDeleteNot(DeleteNot not)
```
    Method specifically processing a fr.dyade.aaa.agent.DeleteNot instance.
    ExceptionReply replies are sent to the pending receivers, and the remaining messages are sent to the DMQ and deleted.
    
    Specified by:
    
    doDeleteNot in class Destination
  - getMsgTxPrefix
```
protected final StringBuffer getMsgTxPrefix()
```
  - setMsgTxName
```
protected final void setMsgTxName(Message msg)
```
  - storeMessage
```
protected final void storeMessage(Message msg,
                                  boolean throwsExceptionOnFullDest)
                           throws AccessException
```
    Actually stores a message in the deliverables list.
    
    Parameters:
    
    msg - The message to store.
    
    throwsExceptionOnFullDest - true, can throws an exception on sending message on full destination
    
    Throws:
    
    AccessException
  - isSyncExceptionOnFullDest
```
public boolean isSyncExceptionOnFullDest()
```
    Returns:
    
    the syncExceptionOnFullDest
  - setSyncExceptionOnFullDest
```
public void setSyncExceptionOnFullDest(boolean syncExceptionOnFullDest)
```
    Parameters:
    
    syncExceptionOnFullDest - the syncExceptionOnFullDest to set
  - addMessage
```
protected final boolean addMessage(Message message,
                                   boolean throwsExceptionOnFullDest)
                            throws AccessException
```
    Adds a message in the list of messages to deliver. This method take care of the message priority if needed.
    
    Parameters:
    
    message - the message to add.
    
    throwsExceptionOnFullDest - true, can throws an exception on sending message on full destination
    
    Returns:
    
    true if the message has been added. false if the queue is full.
    
    Throws:
    
    AccessException - If syncExceptionOnFullDest and the queue isFull
  - getClientMessages
```
protected ClientMessages getClientMessages(int nb,
                                           String selector,
                                           boolean remove)
```
    Get a client message contain nb messages. Only used in ClusterQueue.
    
    Parameters:
    
    nb - number of messages returned in ClientMessage.
    
    selector - jms selector
    
    remove - delete all messages returned if true
    
    Returns:
    
    ClientMessages (contains nb Messages)
  - getMessages
```
private List<Message> getMessages(int nb,
                                  String selector,
                                  boolean remove)
```
    get messages, if it's possible.
    
    Parameters:
    
    nb - Maximum number of messages to return, if -1 returns all messages.
    
    selector - JMS selector.
    
    remove -
    
    Returns:
    
    List of mom messages.
  - getMomMessage
```
private Message getMomMessage(String msgId)
```
  - getQueueMessage
```
protected Message getQueueMessage(String msgId,
                                  boolean remove)
```
    Get mom message, delete if remove = true.
    
    Parameters:
    
    msgId - message identification
    
    remove - if true delete message
    
    Returns:
    
    mom message
  - getMessage
```
public CompositeData getMessage(String msgId)
                         throws Exception
```
    Returns the description of a particular pending message. The message is pointed out through its unique identifier.
    
    Specified by:
    
    getMessage in interface QueueMBean
    
    Parameters:
    
    msgId - The unique message's identifier.
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getMessages
```
public TabularData getMessages()
                        throws Exception
```
    Returns the description of all pending messages.
    
    Specified by:
    
    getMessages in interface QueueMBean
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getMessagesView
```
public List<? extends MessageView> getMessagesView()
```
    Only used from shell-mom MOMCommandsImpl.
  - getDelayedMessage
```
public CompositeData getDelayedMessage(String msgId)
                                throws Exception
```
    Returns the description of a particular delayed message. The message is pointed out through its unique identifier.
    
    Specified by:
    
    getDelayedMessage in interface QueueMBean
    
    Parameters:
    
    msgId - The unique message's identifier.
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getDelayedMessages
```
public TabularData getDelayedMessages()
                               throws Exception
```
    Returns the description of all pending messages.
    
    Specified by:
    
    getDelayedMessages in interface QueueMBean
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - deliverMessages
```
protected void deliverMessages(int index)
```
    Actually tries to answer the pending "receive" requests.
    The method may send QueueMsgReply replies to clients.
    
    Parameters:
    
    index - Index where starting to "browse" the requests.
  - checkDelivery
```
protected boolean checkDelivery(Message msg)
```
    Returns true if conditions are ok to deliver the message. This method must be overloaded in subclasses. Be careful only the message header is accessible.
  - messageDelivered
```
protected void messageDelivered(String msgId)
```
    call in deliverMessages just after forward(msg), overload this method to process a specific treatment.
  - messageRemoved
```
protected void messageRemoved(String msgId)
```
    call in deliverMessages just after a remove message (invalid), overload this method to process a specific treatment.
  - isUndeliverable
```
protected boolean isUndeliverable(Message message)
```
    Returns true if a given message is considered as undeliverable, because its delivery count matches the queue's threshold, if any, or the server's default threshold value (if any).
  - addClientMessages
```
public void addClientMessages(ClientMessages clientMsgs,
                              boolean throwsExceptionOnFullDest)
                       throws AccessException
```
    Adds the client messages in the queue. This method is used when messages does not come from a JMS Client, for example for AcquisitionQueue, AliasQueue and AliasInQueue.
    
    Parameters:
    
    clientMsgs - client message notification.
    
    throwsExceptionOnFullDest - true, can throws an exception on sending message on full destination
    
    Throws:
    
    AccessException
  - handleExpiredNot
```
protected void handleExpiredNot(AgentId from,
                                ExpiredNot not)
```
  - getStats
```
protected Properties getStats()
```
    Specified by:
    
    getStats in class Destination
  - exportMessages
```
public void exportMessages(String dirpath,
                           String selector,
                           boolean binary)
                    throws Exception
```
    Exports all messages in the specified directory. Options? filtrage? Format?
    
    Specified by:
    
    exportMessages in interface QueueMBean
    
    Parameters:
    
    dirpath -
    
    selector -
    
    quiet -
    
    Throws:
    
    Exception
    
    InterruptedException
  - doAdminSyncNotification
```
protected void doAdminSyncNotification(AgentId from,
                                       AdminSyncNotification not)
```
    Handling of AdminSyncNotification. Currently only the EXPORT command is handled.
    
    Overrides:
    
    doAdminSyncNotification in class Agent
    
    Parameters:
    
    from -
    
    not -
  - doExportMessages
```
private void doExportMessages(String dirpath,
                              String selector,
                              boolean binary)
                       throws IOException
```
    Exports all messages in the specified directory. Be careful, this method needs to be called from an agent reaction.
    
    Throws:
    
    IOException
  - getEncodableClassId
```
public int getEncodableClassId()
```
    Description copied from class: Agent
    
    Enables the sub classes not to implement this method.
    
    Specified by:
    
    getEncodableClassId in interface Encodable
    
    Overrides:
    
    getEncodableClassId in class Agent
    
    Returns:
    
    -1
  - getEncodedSize
```
public int getEncodedSize()
                   throws Exception
```
    Description copied from class: Agent
    
    Returns the size of the encoded object.
    
    Specified by:
    
    getEncodedSize in interface Encodable
    
    Overrides:
    
    getEncodedSize in class Destination
    
    Returns:
    
    the size of the encoded object
    
    Throws:
    
    Exception - if an error occurs
  - encode
```
public void encode(Encoder encoder)
            throws Exception
```
    Description copied from class: Agent
    
    Encodes the object.
    
    Specified by:
    
    encode in interface Encodable
    
    Overrides:
    
    encode in class Destination
    
    Parameters:
    
    encoder - the encoder
    
    Throws:
    
    Exception - if an error occurs
  - decode
```
public void decode(Decoder decoder)
            throws Exception
```
    Description copied from class: Agent
    
    Decodes the object.
    
    Specified by:
    
    decode in interface Encodable
    
    Overrides:
    
    decode in class Destination
    
    Parameters:
    
    decoder - the encoder
    
    Throws:
    
    Exception - if an error occurs

Modifier	Constructor	Description
	`Queue()`	Creates a queue.
`protected`	`Queue(String name, boolean fixed, int stamp)`	Creates a queue with a specified stamp.

Class Queue

Nested Class Summary

Field Summary

Fields inherited from class org.objectweb.joram.mom.dest.Destination

Fields inherited from class fr.dyade.aaa.agent.Agent

Fields inherited from interface fr.dyade.aaa.common.encoding.Encodable

Constructor Summary

Method Summary

Methods inherited from class org.objectweb.joram.mom.dest.Destination

Methods inherited from class fr.dyade.aaa.agent.Agent

Methods inherited from class java.lang.Object

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

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

Field Detail

serialVersionUID

logger

DEBUG

logmsg

DELIVERY_TABLE_PREFIX

ARRIVAL_STATE_PREFIX

defaultDMQId

LENIENT_REDELIVERY_DELAY

lenientRedeliveryDelay

LENIENT_UNDELIVERABLE

lenientUndeliverable

DELIVERY_TIMEOUT

DFLT_DELIVERY_TIMEOUT

deliveryTimeout

threshold

defaultThreshold

redeliveryDelay

defaultRedeliveryDelay

deliveryDelay

pause

samePriorities

nbExpirations

priority

deliveryTable

arrivalState

requests

receiving

messages

delayed

nbMsgsDeniedSinceCreation

nbMaxMsg

hprod

hcons

pload

cload

msgTxPrefix

msgTxPrefixLength

syncExceptionOnFullDest

Constructor Detail

Queue

Queue

Method Detail

getThreshold

setThreshold

getDefaultThreshold

getDefaultDMQId

getRedeliveryDelay

setRedeliveryDelay

getDefaultRedeliveryDelay

setDefaultRedeliveryDelay

getDeliveryDelay

setDeliveryDelay

isPause

setPause

setProperties

react

agentSave

cleanWaitingRequest

cleanWaitingRequest

getWaitingRequestCount

getDelayedMessageCount

getType

cleanPendingMessage

cleanPendingMessage

getPendingMessageCount

getDeliveredMessageCount