KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > joram > client > jms > QueueMBean


1 /*
2  * JORAM: Java(TM) Open Reliable Asynchronous Messaging
3  * Copyright (C) 2005 - ScalAgent Distributed Technologies
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18  * USA.
19  *
20  * Initial developer(s): Nicolas Tachker (ScalAgent DT)
21  * Contributor(s):
22  */

23 package org.objectweb.joram.client.jms;
24
25 import java.util.Properties JavaDoc;
26
27 import javax.jms.JMSException JavaDoc;
28 import java.net.ConnectException JavaDoc;
29
30 import org.objectweb.joram.client.jms.admin.AdminException;
31
32 public interface QueueMBean extends DestinationMBean {
33
34   /** Returns a String image of the queue. */
35   public String JavaDoc toString();
36
37   public void setNbMaxMsg(int nbMaxMsg)
38     throws ConnectException JavaDoc, AdminException;
39
40   public int getNbMaxMsg()
41     throws ConnectException JavaDoc, AdminException;
42
43   /**
44    * Admin method setting or unsetting the threshold for this queue.
45    */

46   public void setThreshold(int threshold)
47     throws ConnectException JavaDoc, AdminException;
48
49   /**
50    * Monitoring method returning the threshold of this queue, -1 if not set.
51    */

52   public int getThreshold()
53     throws ConnectException JavaDoc, AdminException;
54    
55   /**
56    * Monitoring method returning the number of pending messages on this queue.
57    */

58   public int getPendingMessages()
59     throws ConnectException JavaDoc, AdminException;
60
61   /**
62    * Monitoring method returning the number of pending requests on this queue.
63    */

64   public int getPendingRequests()
65     throws ConnectException JavaDoc, AdminException;
66
67   public String JavaDoc[] getMessageIds()
68     throws ConnectException JavaDoc, AdminException;
69
70   public String JavaDoc getMessageDigest(String JavaDoc msgId)
71     throws AdminException, ConnectException JavaDoc, JMSException JavaDoc;
72  
73   public Properties JavaDoc getMessageHeader(String JavaDoc msgId)
74     throws ConnectException JavaDoc, AdminException, JMSException JavaDoc;
75   
76   public Properties JavaDoc getMessageProperties(String JavaDoc msgId)
77     throws ConnectException JavaDoc, AdminException, JMSException JavaDoc;
78
79   public void deleteMessage(String JavaDoc msgId)
80     throws ConnectException JavaDoc, AdminException;
81
82   public void clear()
83     throws ConnectException JavaDoc, AdminException;
84 }
85
Popular Tags