Package org.objectweb.joram.client.jms

Class Queue

java.lang.Object

org.objectweb.joram.client.jms.admin.AdministeredObject

org.objectweb.joram.client.jms.Destination

org.objectweb.joram.client.jms.Queue

All Implemented Interfaces:

Serializable, Destination, Queue, Referenceable, DestinationMBean, QueueMBean

Direct Known Subclasses:

DeadMQueue, TemporaryQueue

public class Queue
extends Destination
implements Queue, QueueMBean

Implements the javax.jms.Queue interface.

This is a proxy object a client uses to specify the destination of messages it is sending and the source of messages it receives.

The Queue class is a factory for Joram's Queue destination through the create static methods, the Queue object provides Joram specific administration and monitoring methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DELIVERY_DELAY	Property allowing to fix DeliveryDelay
static String	REDELIVERY_DELAY	Property allowing to fix RedeliveryDelay
private static long	serialVersionUID	define serialVersionUID for interoperability

Fields inherited from class org.objectweb.joram.client.jms.Destination

ACQUISITION_QUEUE, ACQUISITION_TOPIC, adminName, agentId, ALIAS_QUEUE, CLUSTER_QUEUE, DEAD_MQUEUE, DISTRIBUTION_QUEUE, DISTRIBUTION_TOPIC, FTP_QUEUE, JMXBeanName, logger, QUEUE, QUEUE_TYPE, SCHEDULER_QUEUE, TEMPORARY, TOPIC, TOPIC_TYPE, wrapper

Fields inherited from class org.objectweb.joram.client.jms.admin.AdministeredObject

rand

Constructor Summary

Constructors

Modifier	Constructor	Description
	Queue()
	Queue(String name)
protected	Queue(String name, byte type)

Method Summary

Modifier and Type	Method	Description
void	addClusteredQueue(Queue addedQueue)	Adds a queue into the cluster this queue belongs to.
void	addRemoteDestination(String destId)	Adds a destination to an alias queue's destinations' list.
void	addRemoteDestination(Queue remote)	Adds a destination to an alias queue's destinations' list.
void	clear()
static Queue	create()	Administration method creating and deploying a queue on the local server.
static Queue	create(int serverId)	Administration method creating and deploying a queue on a given server.
static Queue	create(int serverId, String name)	Administration method creating and deploying (or retrieving) a queue on a given server with a given name.
static Queue	create(int serverId, String name, String className, Properties prop)	Administration method creating and deploying (or retrieving) a queue on a given server.
static Queue	create(int serverId, String className, Properties prop)	Administration method creating and deploying a queue on a given server.
static Queue	create(int serverId, Properties prop)	Administration method creating and deploying a queue on a given server.
static Queue	create(String name)	Administration method creating and deploying (or retrieving) a queue on the local server.
static Queue	createQueue(String agentId, String name)
void	deleteMessage(String msgId)
void	delRemoteDestination(String destId)	Removes a destination from an alias queue's destinations' list.
void	delRemoteDestination(Queue remote)	Removes a destination from an alias queue's destinations' list.
int	getDeliveredMessages()	Monitoring method returning the number of delivered messages since the queue's creation.
Message	getMessage(String msgId)	Returns a copy of the message.
String	getMessageDigest(String msgId)
Properties	getMessageHeader(String msgId)
String[]	getMessageIds()	Returns the identifiers of all messages in this queue.
Properties	getMessageProperties(String msgId)
int	getNbMaxMsg()	Monitoring method returning the nbMaxMsg of this queue, -1 if no limit.
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.
String[]	getQueueClusterElements()	Returns the reference of the queues that belong to the cluster.
String	getQueueName()	API method.
int	getThreshold()	Monitoring method returning the threshold of this queue, -1 if not set.
Message	readMessage(String msgId)	Deprecated. Since Joram 5.2 use getMessage.
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	removeClusteredQueue(Queue removedQueue)	Deprecated.
void	removeFromCluster()	Removes this queue from the cluster it belongs to.
void	sendDestinationsWeights(int[] weights)	Set weights for each remote destination of this alias queue.
void	setDeliveryDelay(int deliveryDelay)	Set deliveryDelay attribute.
void	setNbMaxMsg(int nbMaxMsg)	Administration method setting nbMaxMsg for this queue.
void	setPause(boolean pause)	Stops / Resumes the message delivery.
org.objectweb.joram.shared.admin.AdminReply	setProperties(Properties prop)	Administration method to set properties.
void	setRedeliveryDelay(int redeliveryDelay)	Set redeliveryDelay attribute.
void	setSyncExceptionOnFull(boolean syncExceptionOnFull)	Administration method setting syncExceptionOnFull for this queue.
void	setThreshold(int threshold)	Administration method setting or unsetting the threshold for this queue.
String	toString()	Returns a String image of the queue.

Methods inherited from class org.objectweb.joram.client.jms.Destination

addInterceptor, addInterceptors, addReader, addWriter, check, checkId, delete, doCreate, doRequest, equals, fromReference, getAdminName, getDMQ, getDMQId, getInterceptors, getJMXBeanName, getName, getReaderList, getReaders, getStatistic, getStatistics, getStatistics, getType, getWrapper, getWriterList, getWriters, hashCode, isFreelyReadable, isFreelyWriteable, isQueue, isTopic, newInstance, registerMBean, removeInterceptors, removeReader, removeWriter, replaceInterceptor, replaceInterceptor, scale, setDMQ, setDMQId, setFreelyReadable, setFreelyWriteable, setFreeReading, setFreeWriting, setReader, setWrapper, setWriter, toReference, toXml, unregisterMBean, unsetFreeReading, unsetFreeWriting, unsetReader, unsetWriter

Methods inherited from class org.objectweb.joram.client.jms.admin.AdministeredObject

getReference

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.objectweb.joram.client.jms.DestinationMBean

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

Field Detail

serialVersionUID

private static final long serialVersionUID

define serialVersionUID for interoperability

See Also:

Constant Field Values

REDELIVERY_DELAY

public static final String REDELIVERY_DELAY

Property allowing to fix RedeliveryDelay

See Also:

Constant Field Values

DELIVERY_DELAY

public static final String DELIVERY_DELAY

Property allowing to fix DeliveryDelay

See Also:

Constant Field Values

Constructor Detail

Queue

public Queue()

Queue

public Queue(String name)

Queue

protected Queue(String name,
                byte type)

Method Detail

toString

public String toString()

Returns a String image of the queue.

Specified by:

toString in interface Queue

Overrides:

toString in class Object

Returns:

A provider-specific identity values for this queue.

getQueueName

public String getQueueName()
                    throws JMSException

API method. Gets the The Joram's internal unique identifier of this queue.

Specified by:

getQueueName in interface Queue

Returns:

The Joram's internal unique identifier.

Throws:

JMSException - Actually never thrown.

createQueue

public static Queue createQueue(String agentId,
                                String name)

create

public static Queue create()
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a queue on the local server.

The request fails if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

create

public static Queue create(int serverId)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a queue on a given server.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

create

public static Queue create(String name)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying (or retrieving) a queue on the local server. First a destination with the specified name is searched on the given server, if it does not exist it is created. In any case, its provider-specific address is returned.

The request fails if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

name - The queue name.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

create

public static Queue create(int serverId,
                           String name)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying (or retrieving) a queue on a given server with a given name. First a destination with the specified name is searched on the given server, if it does not exist it is created. In any case, its provider-specific address is returned.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The queue name.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

create

public static Queue create(int serverId,
                           Properties prop)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a queue on a given server. It creates a Joram's standard queue.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

prop - The queue properties.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

create

public static Queue create(int serverId,
                           String className,
                           Properties prop)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying a queue on a given server.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

className - The queue class name.

prop - The queue properties.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

create

public static Queue create(int serverId,
                           String name,
                           String className,
                           Properties prop)
                    throws ConnectException,
                           AdminException

Administration method creating and deploying (or retrieving) a queue on a given server. First a destination with the specified name is searched on the given server, if it does not exist it is created. In any case, its provider-specific address is returned.

The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.

Be careful this method use the static AdminModule connection.

Parameters:

serverId - The identifier of the server where deploying the queue.

name - The name of the queue.

className - The MOM's queue class name.

prop - The queue properties.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

setThreshold

public void setThreshold(int threshold)
                  throws ConnectException,
                         AdminException

Administration method setting or unsetting the threshold for this queue.

The request fails if the queue is deleted server side.

Specified by:

setThreshold in interface QueueMBean

Parameters:

threshold - The threshold value to be set (-1 for unsetting previous value).

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

getThreshold

public int getThreshold()
                 throws ConnectException,
                        AdminException

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

The request fails if the queue is deleted server side.

Specified by:

getThreshold in interface QueueMBean

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

setNbMaxMsg

public void setNbMaxMsg(int nbMaxMsg)
                 throws ConnectException,
                        AdminException

Administration method setting nbMaxMsg for this queue.

The request fails if the queue is deleted server side.

Specified by:

setNbMaxMsg in interface QueueMBean

Parameters:

nbMaxMsg - nb Max of Message (-1 no limit).

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

getNbMaxMsg

public int getNbMaxMsg()
                throws ConnectException,
                       AdminException

Monitoring method returning the nbMaxMsg of this queue, -1 if no limit.

The request fails if the queue is deleted server side.

Specified by:

getNbMaxMsg in interface QueueMBean

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

setSyncExceptionOnFull

public void setSyncExceptionOnFull(boolean syncExceptionOnFull)
                            throws ConnectException,
                                   AdminException

Administration method setting syncExceptionOnFull for this queue.

The request fails if the queue is deleted server side.

Parameters:

syncExceptionOnFull - true, throws an exception on sending message on full destination.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

getPendingMessages

public int getPendingMessages()
                       throws ConnectException,
                              AdminException

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

The request fails if the queue is deleted server side.

Specified by:

getPendingMessages in interface QueueMBean

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

getPendingRequests

public int getPendingRequests()
                       throws ConnectException,
                              AdminException

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

The request fails if the queue is deleted server side.

Specified by:

getPendingRequests in interface QueueMBean

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

getDeliveredMessages

public int getDeliveredMessages()
                         throws ConnectException,
                                AdminException

Monitoring method returning the number of delivered messages since the queue's creation.

The request fails if the queue is deleted server side.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

getMessageIds

public String[] getMessageIds()
                       throws AdminException,
                              ConnectException

Returns the identifiers of all messages in this queue.

Specified by:

getMessageIds in interface QueueMBean

Returns:

The identifiers of all messages in this queue.

Throws:

AdminException

ConnectException

See Also:

QueueMBean.getMessageIds()

getMessage

public Message getMessage(String msgId)
                   throws AdminException,
                          ConnectException,
                          JMSException

Returns a copy of the message.

Parameters:

msgId - The identifier of the message.

Returns:

The message

Throws:

AdminException

ConnectException

JMSException

readMessage

public Message readMessage(String msgId)
                    throws AdminException,
                           ConnectException,
                           JMSException

Deprecated.

Since Joram 5.2 use getMessage.

Returns a copy of the message.

Parameters:

msgId - The identifier of the message.

Returns:

The message

Throws:

AdminException

ConnectException

JMSException

getMessageDigest

public String getMessageDigest(String msgId)
                        throws AdminException,
                               ConnectException,
                               JMSException

Specified by:

getMessageDigest in interface QueueMBean

Throws:

AdminException

ConnectException

JMSException

getMessageHeader

public Properties getMessageHeader(String msgId)
                            throws AdminException,
                                   ConnectException,
                                   JMSException

Specified by:

getMessageHeader in interface QueueMBean

Throws:

AdminException

ConnectException

JMSException

getMessageProperties

public Properties getMessageProperties(String msgId)
                                throws AdminException,
                                       ConnectException,
                                       JMSException

Specified by:

getMessageProperties in interface QueueMBean

Throws:

AdminException

ConnectException

JMSException

deleteMessage

public void deleteMessage(String msgId)
                   throws AdminException,
                          ConnectException

Specified by:

deleteMessage in interface QueueMBean

Throws:

AdminException

ConnectException

clear

public void clear()
           throws AdminException,
                  ConnectException

Specified by:

clear in interface QueueMBean

Throws:

AdminException

ConnectException

addClusteredQueue

public void addClusteredQueue(Queue addedQueue)
                       throws ConnectException,
                              AdminException

Adds a queue into the cluster this queue belongs to. If this queue doesn't belong to a cluster then a cluster is created by clustering this queue with the added queue.

The request fails if one or both of the queues are deleted, or can't belong to a cluster.

Parameters:

addedQueue - queue added to the cluster

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

removeClusteredQueue

public void removeClusteredQueue(Queue removedQueue)
                          throws ConnectException,
                                 AdminException

Deprecated.

Removes a queue from the cluster this queue belongs to.

The request fails if the queue does not exist or is not part of any cluster.

Parameters:

removedQueue - queue removed from the cluster

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

removeFromCluster

public void removeFromCluster()
                       throws ConnectException,
                              AdminException

Removes this queue from the cluster it belongs to.

The request fails if the queue does not exist or is not part of any cluster.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

getQueueClusterElements

public String[] getQueueClusterElements()
                                 throws ConnectException,
                                        AdminException

Returns the reference of the queues that belong to the cluster.

Throws:

ConnectException - If the admin connection is closed or broken.

AdminException - If the request fails.

registerAsDefaultDMQ

public void registerAsDefaultDMQ()
                          throws ConnectException,
                                 AdminException

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

Specified by:

registerAsDefaultDMQ in interface QueueMBean

Throws:

ConnectException - If the connection fails.

AdminException - Never thrown.

registerAsDefaultDMQ

public 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.

Specified by:

registerAsDefaultDMQ in interface QueueMBean

Parameters:

serverId - The identifier of the server.

Throws:

ConnectException - If the connection fails.

AdminException - If the request fails.

addRemoteDestination

public void addRemoteDestination(String destId)
                          throws ConnectException,
                                 AdminException

Adds a destination to an alias queue's destinations' list.

Parameters:

destId - The internal name of remote destination

Throws:

ConnectException

AdminException

addRemoteDestination

public void addRemoteDestination(Queue remote)
                          throws ConnectException,
                                 AdminException

Adds a destination to an alias queue's destinations' list.

Parameters:

remote - The remote queue to add

Throws:

ConnectException

AdminException

delRemoteDestination

public void delRemoteDestination(String destId)
                          throws ConnectException,
                                 AdminException

Removes a destination from an alias queue's destinations' list.

Parameters:

destId - The internal name of remote destination

Throws:

ConnectException

AdminException

delRemoteDestination

public void delRemoteDestination(Queue remote)
                          throws ConnectException,
                                 AdminException

Removes a destination from an alias queue's destinations' list.

Parameters:

remote - The remote queue to remove

Throws:

ConnectException

AdminException

sendDestinationsWeights

public void sendDestinationsWeights(int[] weights)
                             throws ConnectException,
                                    AdminException

Set weights for each remote destination of this alias queue.

Parameters:

weights -

Throws:

ConnectException

AdminException

setRedeliveryDelay

public void setRedeliveryDelay(int redeliveryDelay)
                        throws ConnectException,
                               AdminException

Set redeliveryDelay attribute.

Parameters:

redeliveryDelay - The delay in seconds use to wait before re-delivering messages after a deny.

Throws:

ConnectException

AdminException

setDeliveryDelay

public void setDeliveryDelay(int deliveryDelay)
                      throws ConnectException,
                             AdminException

Set deliveryDelay attribute.

Parameters:

deliveryDelay - The minimum delay in milliseconds use to wait before delivering each message.

Throws:

ConnectException

AdminException

setPause

public void setPause(boolean pause)
              throws ConnectException,
                     AdminException

Stops / Resumes the message delivery.

Parameters:

pause - if true stops the message delivery, else resumes it.

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.

setProperties

public org.objectweb.joram.shared.admin.AdminReply setProperties(Properties prop)
                                                          throws ConnectException,
                                                                 AdminException

Administration method to set properties.

Overrides:

setProperties in class Destination

Parameters:

prop - the properties to update.

Returns:

the admin reply

Throws:

ConnectException - If the administration connection is closed or broken.

AdminException - If the request fails.