KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > mq > server > jmx > DestinationMBean


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.mq.server.jmx;
23
24 import javax.management.ObjectName JavaDoc;
25 import org.jboss.system.ServiceMBean;
26 import org.jboss.mq.MessageStatistics;
27 import org.jboss.mq.server.MessageCounter;
28
29 /**
30  * MBean interface for destination managers.
31  *
32  *
33  * @author <a HREF="pra@tim.se">Peter Antman</a>
34  * @version $Revision: 37459 $
35  */
36 public interface DestinationMBean extends ServiceMBean
37 {
38    /**
39     * Get the value of JBossMQService.
40     * @return value of JBossMQService.
41     */
42    void removeAllMessages() throws Exception JavaDoc;
43    
44    /**
45     * Get the value of JBossMQService.
46     * @return value of JBossMQService.
47     */
48    ObjectName JavaDoc getDestinationManager();
49    
50    /**
51     * Set the value of JBossMQService.
52     * @param v Value to assign to JBossMQService.
53     */
54    void setDestinationManager(ObjectName JavaDoc jbossMQService);
55
56     /**
57     * Sets the JNDI name for this destination
58     * @param name Name to bind this topic to in the JNDI tree
59     */
60    void setJNDIName(String JavaDoc name) throws Exception JavaDoc;
61
62    /**
63     * Gets the JNDI name use by this destination.
64     * @return The JNDI name currently in use
65     */
66    String JavaDoc getJNDIName();
67    
68    /**
69     * Sets the security xml config
70     */
71    //void setSecurityConf(String securityConf) throws Exception;
72 void setSecurityConf(org.w3c.dom.Element JavaDoc securityConf) throws Exception JavaDoc;
73    
74    /**
75     * Set the object name of the security manager.
76     */
77    public void setSecurityManager(ObjectName JavaDoc securityManager);
78    
79    /**
80     * get message counter of all internal queues
81     */
82    public MessageCounter[] getMessageCounter();
83    
84    /**
85    * get message statistics of all internal queues
86    */
87    public MessageStatistics[] getMessageStatistics() throws Exception JavaDoc;
88
89    /**
90     * List destination message counter
91     * @return String
92     */
93    public String JavaDoc listMessageCounter();
94    
95    /**
96     * Reset destination message counter
97     */
98    public void resetMessageCounter();
99    
100    /**
101     * List destination message counter history
102     * @return String
103     */
104    public String JavaDoc listMessageCounterHistory();
105    
106    /**
107     * Reset destination message counter history
108     */
109    public void resetMessageCounterHistory();
110
111    /**
112     * Sets the destination message counter history day limit
113     * <0: unlimited, =0: disabled, > 0 maximum day count
114     *
115     * @param days maximum day count
116     */
117    public void setMessageCounterHistoryDayLimit( int days );
118
119    /**
120     * Gets the destination message counter history day limit
121     * @return Maximum day count
122     */
123    public int getMessageCounterHistoryDayLimit();
124
125    /**
126     * Retrieve the maximum depth of the queue or individual
127     * subscriptions
128     * @return the maximum depth
129     */
130    public int getMaxDepth();
131    
132    /**
133     * Set the maximum depth of the queue or individual subscriptions
134     * @param depth the maximum depth, zero means unlimited
135     */
136    public void setMaxDepth(int depth);
137
138    /**
139     * Retrieve the topic/queue in memory mode
140     * @return true for in memory
141     */
142    public boolean getInMemory();
143
144    /**
145     * Set the temporary topic/queue in memory mode
146     * @parameters true for in memory
147     */
148    public void setInMemory(boolean mode);
149    
150    /**
151     * Returns the message redelivery limit; the number of redelivery attempts
152     * before a message is moved to the DLQ.
153     */
154    public int getRedeliveryLimit();
155
156    /**
157     * Sets the redelivery limit.
158     */
159    public void setRedeliveryLimit(int limit);
160
161    /**
162     * Returns the message redelivery delay, the delay in milliseconds before a
163     * rolled back or recovered message is redelivered
164     */
165    public long getRedeliveryDelay();
166
167    /**
168     * Sets the Message redelivery delay in milliseconds.
169     */
170    public void setRedeliveryDelay(long rDelay);
171
172    /**
173     * Returns the implementation class for receivers
174     */
175    public Class JavaDoc getReceiversImpl();
176
177    /**
178     * Sets the class implementating the receivers
179     */
180    public void setReceiversImpl(Class JavaDoc receivers);
181
182    /**
183     * Returns the recovery retries
184     */
185    public int getRecoveryRetries();
186
187    /**
188     * Sets the class implementating the receivers
189     */
190    public void setRecoveryRetries(int retries);
191
192    /**
193     * Returns the expiry destination.
194     */
195    public ObjectName JavaDoc getExpiryDestination();
196
197    /**
198     * Sets the expiry destination.
199     */
200    public void setExpiryDestination(ObjectName JavaDoc destination);
201
202 }
203
Popular Tags