KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mr > kernel > services > queues > QueueServiceMBean


1 /*
2  * Copyright 2002 by
3  * <a HREF="http://www.coridan.com">Coridan</a>
4  * <a HREF="mailto: support@coridan.com ">support@coridan.com</a>
5  *
6  * The contents of this file are subject to the Mozilla Public License Version
7  * 1.1 (the "License"); you may not use this file except in compliance with the
8  * License. You may obtain a copy of the License at
9  * http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is "MantaRay" (TM).
17  *
18  * The Initial Developer of the Original Code is lital kasif.
19  * Portions created by the Initial Developer are Copyright (C) 2006
20  * Coridan Inc. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source
23  * code where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LESSER GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LESSER GENERAL PUBLIC LICENSE.
34  
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Lesser General Public License as published by the Free Software Foundation;
39  * either version 2.1 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
44  * License for more details.
45  *
46  * Created on Apr 28, 2005
47  *
48  * Coridan LTD
49  */

50 package org.mr.kernel.services.queues;
51
52 import java.util.List JavaDoc;
53
54 /**
55  * TODO To change the template for this generated type comment go to
56  * Window - Preferences - Java - Code Style - Code Templates
57  *
58  * @author lital kasif
59  *
60  */

61 public interface QueueServiceMBean {
62     /**
63      * JMS message is shown in a visual was in the JMX console
64      * here are the key to the desc of the messages
65      */

66     public final static String JavaDoc MESSAGE_ID = "msg-id";
67     
68     public final static String JavaDoc MESSAGE_TEXT = "text";
69     
70     public final static String JavaDoc MESSAGE_HEADERS = "headers";
71     
72     public final static String JavaDoc MESSAGE_PROPERTIES = "prop";
73     
74     /**
75      * Paused the queue. Pausing means producers will still be able to produce
76      * messages, but those messages will be held inside the queue and not sent
77      * to the consumers until the queue is resumed again.
78      */

79     public void pause();
80     
81     /**
82      * resumes a queue that was paused.
83      */

84     public void resume();
85     
86     /**
87      * Purges all the messages currently held by the queue. This method
88      * can be operated only after the queue has been paused.
89      */

90     public void purge();
91     
92     /**
93      * @return true if the queue is paused at the moment, false otherwise
94      */

95     public boolean isPaused();
96     
97     /**
98      *
99      * @return
100      */

101     public List JavaDoc examineMessages();
102 }
103
Popular Tags