org.ow2.joram.jakarta.jms

Interface QueueMBean

All Superinterfaces:

DestinationMBean

All Known Implementing Classes:

Queue, TemporaryQueue

public interface QueueMBean
extends DestinationMBean

Method Summary

Modifier and Type	Method and Description
void	clear()
void	deleteMessage(String msgId)
String	getMessageDigest(String msgId)
Properties	getMessageHeader(String msgId)
String[]	getMessageIds()
Properties	getMessageProperties(String msgId)
int	getNbMaxMsg()
int	getPendingMessages() Monitoring method returning the number of pending messages on this queue.
int	getPendingRequests() Monitoring method returning the number of pending requests on this queue.
int	getThreshold() Monitoring method returning the threshold of this queue, -1 if not set.
void	registerAsDefaultDMQ() Sets the current queue as the default DMQ for the local server.
void	registerAsDefaultDMQ(int serverId) Sets the current queue as the default DMQ for the given server.
void	setNbMaxMsg(int nbMaxMsg)
void	setThreshold(int threshold) Admin method setting or unsetting the threshold for this queue.

Methods inherited from interface org.ow2.joram.jakarta.jms.DestinationMBean

addInterceptors, addReader, addWriter, delete, getAdminName, getDMQId, getInterceptors, getName, getReaderList, getStatistic, getStatistics, getWriterList, isFreelyReadable, isFreelyWriteable, isQueue, isTopic, removeInterceptors, removeReader, removeWriter, setDMQId, setFreelyReadable, setFreelyWriteable

Method Detail

setNbMaxMsg

void setNbMaxMsg(int nbMaxMsg)
          throws ConnectException,
                 AdminException

Throws:

ConnectException

AdminException

getNbMaxMsg

int getNbMaxMsg()
         throws ConnectException,
                AdminException

Throws:

ConnectException

AdminException

setThreshold

void setThreshold(int threshold)
           throws ConnectException,
                  AdminException

Admin method setting or unsetting the threshold for this queue.

Throws:

ConnectException

AdminException

getThreshold

int getThreshold()
          throws ConnectException,
                 AdminException

Monitoring method returning the threshold of this queue, -1 if not set.

Throws:

ConnectException

AdminException

getPendingMessages

int getPendingMessages()
                throws ConnectException,
                       AdminException

Monitoring method returning the number of pending messages on this queue.

Throws:

ConnectException

AdminException

getPendingRequests

int getPendingRequests()
                throws ConnectException,
                       AdminException

Monitoring method returning the number of pending requests on this queue.

Throws:

ConnectException

AdminException

getMessageIds

String[] getMessageIds()
                throws ConnectException,
                       AdminException

Throws:

ConnectException

AdminException

getMessageDigest

String getMessageDigest(String msgId)
                 throws AdminException,
                        ConnectException,
                        jakarta.jms.JMSException

Throws:

AdminException

ConnectException

jakarta.jms.JMSException

getMessageHeader

Properties getMessageHeader(String msgId)
                     throws ConnectException,
                            AdminException,
                            jakarta.jms.JMSException

Throws:

ConnectException

AdminException

jakarta.jms.JMSException

getMessageProperties

Properties getMessageProperties(String msgId)
                         throws ConnectException,
                                AdminException,
                                jakarta.jms.JMSException

Throws:

ConnectException

AdminException

jakarta.jms.JMSException

deleteMessage

void deleteMessage(String msgId)
            throws ConnectException,
                   AdminException

Throws:

ConnectException

AdminException

clear

void clear()
    throws ConnectException,
           AdminException

Throws:

ConnectException

AdminException

registerAsDefaultDMQ

void registerAsDefaultDMQ()
                   throws ConnectException,
                          AdminException

Sets the current queue as the default DMQ for the local server.

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

registerAsDefaultDMQ

void registerAsDefaultDMQ(int serverId)
                   throws ConnectException,
                          AdminException

Sets the current queue as the default DMQ for the given server.

The request fails if the target server does not belong to the platform.

Parameters:

serverId - The identifier of the server.

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.