org.objectweb.joram.client.jms.Queue Class Reference

Inherits org.objectweb.joram.client.jms.Destination, and org.objectweb.joram.client.jms.QueueMBean.

Inherited by org.objectweb.joram.client.jms.admin.DeadMQueue.

Inheritance diagram for org.objectweb.joram.client.jms.Queue:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.joram.client.jms.Queue:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Queue ()
 Queue (String name)
String getQueueName () throws JMSException
void setThreshold (int threshold) throws ConnectException, AdminException
int getThreshold () throws ConnectException, AdminException
void setNbMaxMsg (int nbMaxMsg) throws ConnectException, AdminException
int getNbMaxMsg () throws ConnectException, AdminException
int getPendingMessages () throws ConnectException, AdminException
int getPendingRequests () throws ConnectException, AdminException
String[] getMessageIds () throws AdminException, ConnectException
javax.jms.Message readMessage (String msgId) throws AdminException, ConnectException, JMSException
String getMessageDigest (String msgId) throws AdminException, ConnectException, JMSException
Properties getMessageHeader (String msgId) throws AdminException, ConnectException, JMSException
Properties getMessageProperties (String msgId) throws AdminException, ConnectException, JMSException
void deleteMessage (String msgId) throws AdminException, ConnectException
void clear () throws AdminException, ConnectException
void addClusteredQueue (Queue addedQueue) throws ConnectException, AdminException
void removeClusteredQueue (Queue removedQueue) throws ConnectException, AdminException
String[] getQueueClusterElements () throws ConnectException, AdminException

Static Public Member Functions

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

Protected Member Functions

 Queue (String name, String type)

Detailed Description

Implements the javax.jms.Queue interface and provides Joram specific administration and monitoring methods. This is a proxy object a client uses to specify the destination of messages it is sending and the source of messages it receives.

Definition at line 50 of file Queue.java.


Member Function Documentation

String org.objectweb.joram.client.jms.Queue.getQueueName (  )  throws JMSException

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

Exceptions:
JMSException Actually never thrown.
Returns:
The Joram's internal unique identifier.

Definition at line 81 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.getName(), and org.objectweb.joram.client.jms.Queue.getQueueName().

Referenced by org.objectweb.joram.client.jms.Queue.getQueueName().

Here is the call graph for this function:

static Queue org.objectweb.joram.client.jms.Queue.create ( int  serverId,
String  name,
String  className,
Properties  prop 
) throws ConnectException, AdminException [static]

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

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.
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Definition at line 102 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.create(), org.objectweb.joram.client.jms.Destination.doCreate(), and fr.dyade.aaa.util.Queue.Queue().

Referenced by org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

static Queue org.objectweb.joram.client.jms.Queue.create ( int  serverId,
String  className,
Properties  prop 
) throws ConnectException, AdminException [static]

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

Parameters:
serverId The identifier of the server where deploying the queue.
className The queue class name.
prop The queue properties.
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Definition at line 134 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

static Queue org.objectweb.joram.client.jms.Queue.create ( int  serverId,
Properties  prop 
) throws ConnectException, AdminException [static]

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

Parameters:
serverId The identifier of the server where deploying the queue.
prop The queue properties.
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Definition at line 154 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

static Queue org.objectweb.joram.client.jms.Queue.create ( int  serverId,
String  name 
) throws ConnectException, AdminException [static]

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

Parameters:
serverId The identifier of the server where deploying the queue.
name The queue name.
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Reimplemented in org.objectweb.joram.client.jms.admin.DeadMQueue.

Definition at line 174 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

static Queue org.objectweb.joram.client.jms.Queue.create ( String  name  )  throws ConnectException, AdminException [static]

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

Parameters:
name The queue name.
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Definition at line 192 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

static Queue org.objectweb.joram.client.jms.Queue.create ( int  serverId  )  throws ConnectException, AdminException [static]

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

Parameters:
serverId The identifier of the server where deploying the queue.
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Reimplemented in org.objectweb.joram.client.jms.admin.DeadMQueue.

Definition at line 211 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

static Queue org.objectweb.joram.client.jms.Queue.create (  )  throws ConnectException, AdminException [static]

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

The request fails if the destination deployment fails server side.

Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Reimplemented in org.objectweb.joram.client.jms.admin.DeadMQueue.

Definition at line 224 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.create().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Queue.setThreshold ( int  threshold  )  throws ConnectException, AdminException

Admin method setting or unsetting the threshold for this queue.

The request fails if the queue is deleted server side.

Parameters:
threshold The threshold value to be set (-1 for unsetting previous value).
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Implements org.objectweb.joram.client.jms.QueueMBean.

Definition at line 239 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, and org.objectweb.joram.client.jms.Queue.setThreshold().

Referenced by org.objectweb.joram.client.jms.admin.JoramSaxWrapper.endElement(), and org.objectweb.joram.client.jms.Queue.setThreshold().

Here is the call graph for this function:

int org.objectweb.joram.client.jms.Queue.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.

Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Implements org.objectweb.joram.client.jms.QueueMBean.

Definition at line 256 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, org.objectweb.joram.shared.admin.Monitor_GetDMQSettingsRep.getThreshold(), and org.objectweb.joram.client.jms.Queue.getThreshold().

Referenced by org.objectweb.joram.client.jms.Queue.getThreshold().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Queue.setNbMaxMsg ( int  nbMaxMsg  )  throws ConnectException, AdminException

Admin method setting nbMaxMsg for this queue.

The request fails if the queue is deleted server side.

Parameters:
nbMaxMsg nb Max of Message (-1 no limit).
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Implements org.objectweb.joram.client.jms.QueueMBean.

Definition at line 278 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, and org.objectweb.joram.client.jms.Queue.setNbMaxMsg().

Referenced by org.objectweb.joram.client.jms.admin.JoramSaxWrapper.endElement(), and org.objectweb.joram.client.jms.Queue.setNbMaxMsg().

Here is the call graph for this function:

int org.objectweb.joram.client.jms.Queue.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.

Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Implements org.objectweb.joram.client.jms.QueueMBean.

Definition at line 291 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, org.objectweb.joram.shared.admin.Monitor_GetNbMaxMsgRep.getNbMaxMsg(), and org.objectweb.joram.client.jms.Queue.getNbMaxMsg().

Referenced by org.objectweb.joram.client.jms.Queue.getNbMaxMsg().

Here is the call graph for this function:

int org.objectweb.joram.client.jms.Queue.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.

Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Implements org.objectweb.joram.client.jms.QueueMBean.

Definition at line 307 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, org.objectweb.joram.shared.admin.Monitor_GetNumberRep.getNumber(), and org.objectweb.joram.client.jms.Queue.getPendingMessages().

Referenced by org.objectweb.joram.client.jms.Queue.getPendingMessages().

Here is the call graph for this function:

int org.objectweb.joram.client.jms.Queue.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.

Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Implements org.objectweb.joram.client.jms.QueueMBean.

Definition at line 325 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, org.objectweb.joram.shared.admin.Monitor_GetNumberRep.getNumber(), and org.objectweb.joram.client.jms.Queue.getPendingRequests().

Referenced by org.objectweb.joram.client.jms.Queue.getPendingRequests().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Queue.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
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Definition at line 438 of file Queue.java.

References org.objectweb.joram.client.jms.Queue.addClusteredQueue(), and org.objectweb.joram.client.jms.Destination.agentId.

Referenced by org.objectweb.joram.client.jms.Queue.addClusteredQueue(), and org.objectweb.joram.client.jms.admin.JoramSaxWrapper.endElement().

Here is the call graph for this function:

void org.objectweb.joram.client.jms.Queue.removeClusteredQueue ( Queue  removedQueue  )  throws ConnectException, AdminException

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
Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Definition at line 455 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, and org.objectweb.joram.client.jms.Queue.removeClusteredQueue().

Referenced by org.objectweb.joram.client.jms.Queue.removeClusteredQueue().

Here is the call graph for this function:

String [] org.objectweb.joram.client.jms.Queue.getQueueClusterElements (  )  throws ConnectException, AdminException

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

Exceptions:
ConnectException If the admin connection is closed or broken.
AdminException If the request fails.

Definition at line 467 of file Queue.java.

References org.objectweb.joram.client.jms.Destination.agentId, org.objectweb.joram.client.jms.Queue.getQueueClusterElements(), and org.objectweb.joram.shared.admin.AdminReply.getReplyObject().

Referenced by org.objectweb.joram.client.jms.Queue.getQueueClusterElements().

Here is the call graph for this function:


The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:17:59 2008 for joram by  doxygen 1.5.0