org.objectweb.joram.mom.dest
Interface QueueImplMBean

All Superinterfaces:

DestinationImplMBean

All Known Implementing Classes:

ClusterQueueImpl, JMSBridgeQueueImpl, QueueImpl

public interface QueueImplMBean
extends DestinationImplMBean

Method Summary

void	cleanPendingMessage() Removes all messages that the time-to-live is expired.
void	cleanWaitingRequest() Removes all request that the expiration time is expired.
int	getDeliveredMessageCount() Returns the number of messages delivered and waiting for acknowledge.
javax.management.openmbean.CompositeData	getMessage(java.lang.String msgId) Returns the description of a particular pending message.
javax.management.openmbean.TabularData	getMessages() Returns the description of all pending messages.
int	getNbMaxMsg() Returns the maximum number of message for the destination.
int	getPendingMessageCount() Returns the number of pending messages in the queue.
long	getPeriod() Returns the period value of this queue, -1 if not set.
int	getThreshold() Returns the threshold value of this queue, -1 if not set.
int	getWaitingRequestCount() Returns the number of waiting requests in the queue.
void	setNbMaxMsg(int nbMaxMsg) Sets the maximum number of message for the destination.
void	setPeriod(long period) Sets or unsets the period for this queue.
void	setThreshold(int threshold) Sets or unsets the threshold for this queue.

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

getCreationDate, getCreationTimeInMillis, getDestinationId, getDMQId, getNbMsgsDeliverSinceCreation, getNbMsgsReceiveSinceCreation, getNbMsgsSentToDMQSinceCreation, getRight, getRights, isFreeReading, isFreeWriting, setFreeReading, setFreeWriting, toString

Method Detail

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.

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()

Removes all request that the expiration time is expired.

getPendingMessageCount

int getPendingMessageCount()

Returns the number of pending messages in the queue.

Returns:

The number of pending messages.

cleanPendingMessage

void cleanPendingMessage()

Removes all messages that the time-to-live is expired.

getDeliveredMessageCount

int getDeliveredMessageCount()

Returns the number of messages delivered and waiting for acknowledge.

Returns:

The number of messages delivered.

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

javax.management.openmbean.CompositeData getMessage(java.lang.String msgId)
                                                    throws java.lang.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:

java.lang.Exception

See Also:

MessageJMXWrapper

getMessages

javax.management.openmbean.TabularData getMessages()
                                                   throws java.lang.Exception

Returns the description of all pending messages.

Returns:

the description of the message.

Throws:

java.lang.Exception

See Also:

MessageJMXWrapper