001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.activemq.broker.jmx;
018    
019    import javax.jms.InvalidSelectorException;
020    import javax.management.ObjectName;
021    
022    /**
023     *
024     */
025    public interface SubscriptionViewMBean {
026    
027        /**
028         * @return the clientId of the Connection the Subscription is on
029         */
030        @MBeanInfo("JMS Client id of the Connection the Subscription is on.")
031        String getClientId();
032    
033        /**
034         * @return the id of the Connection the Subscription is on
035         */
036        @MBeanInfo("ID of the Connection the Subscription is on.")
037        String getConnectionId();
038    
039        /**
040         * @return the id of the Session the subscription is on
041         */
042        @MBeanInfo("ID of the Session the Subscription is on.")
043        long getSessionId();
044    
045        /**
046         * @return the id of the Subscription
047         */
048        @MBeanInfo("ID of the Subscription.")
049        long getSubcriptionId();
050    
051        /**
052         * @return the destination name
053         */
054        @MBeanInfo("The name of the destionation the subscription is on.")
055        String getDestinationName();
056    
057        /**
058         * @return the JMS selector on the current subscription
059         */
060        @MBeanInfo("The SQL-92 message header selector or XPATH body selector of the subscription.")
061        String getSelector();
062    
063        /**
064         * Attempts to change the current active selector on the subscription. This
065         * operation is not supported for persistent topics.
066         */
067        void setSelector(@MBeanInfo("selector") String selector) throws InvalidSelectorException, UnsupportedOperationException;
068    
069        /**
070         * @return true if the destination is a Queue
071         */
072        @MBeanInfo("Subscription is on a Queue")
073        boolean isDestinationQueue();
074    
075        /**
076         * @return true of the destination is a Topic
077         */
078        @MBeanInfo("Subscription is on a Topic")
079        boolean isDestinationTopic();
080    
081        /**
082         * @return true if the destination is temporary
083         */
084        @MBeanInfo("Subscription is on a temporary Queue/Topic")
085        boolean isDestinationTemporary();
086    
087        /**
088         * @return true if the subscriber is active
089         */
090        @MBeanInfo("Subscription is active (connected and receiving messages).")
091        boolean isActive();
092    
093        @MBeanInfo("Subscription was created by a demand-forwarding network bridge")
094        boolean isNetwork();
095    
096        /**
097         * @return number of messages pending delivery
098         */
099        @MBeanInfo("Number of messages pending delivery.")
100        int getPendingQueueSize();
101    
102        /**
103         * @return number of messages dispatched
104         */
105        @MBeanInfo("Number of messages dispatched awaiting acknowledgement.")
106        int getDispatchedQueueSize();
107    
108        /**
109         * The same as the number of messages dispatched -
110         * making it explicit
111         * @return
112         */
113        @MBeanInfo("Number of messages dispatched awaiting acknowledgement.")
114        int getMessageCountAwaitingAcknowledge();
115    
116        /**
117         * @return number of messages that matched the subscription
118         */
119        @MBeanInfo("Number of messages that sent to the client.")
120        long getDispatchedCounter();
121    
122        /**
123         * @return number of messages that matched the subscription
124         */
125        @MBeanInfo("Number of messages that matched the subscription.")
126        long getEnqueueCounter();
127    
128        /**
129         * @return number of messages queued by the client
130         */
131        @MBeanInfo("Number of messages were sent to and acknowledge by the client.")
132        long getDequeueCounter();
133    
134        /**
135         * @return the prefetch that has been configured for this subscriber
136         */
137        @MBeanInfo("Number of messages to pre-fetch and dispatch to the client.")
138        int getPrefetchSize();
139    
140        /**
141         * @return whether or not the subscriber is retroactive or not
142         */
143        @MBeanInfo("The subscriber is retroactive (tries to receive broadcasted topic messages sent prior to connecting)")
144        boolean isRetroactive();
145    
146        /**
147         * @return whether or not the subscriber is an exclusive consumer
148         */
149        @MBeanInfo("The subscriber is exclusive (no other subscribers may receive messages from the destination as long as this one is)")
150        boolean isExclusive();
151    
152        /**
153         * @return whether or not the subscriber is durable (persistent)
154         */
155        @MBeanInfo("The subsription is persistent.")
156        boolean isDurable();
157    
158        /**
159         * @return whether or not the subscriber ignores local messages
160         */
161        @MBeanInfo("The subsription ignores local messages.")
162        boolean isNoLocal();
163    
164        /**
165         * @return the maximum number of pending messages allowed in addition to the
166         *         prefetch size. If enabled to a non-zero value then this will
167         *         perform eviction of messages for slow consumers on non-durable
168         *         topics.
169         */
170        @MBeanInfo("The maximum number of pending messages allowed (in addition to the prefetch size).")
171        int getMaximumPendingMessageLimit();
172    
173        /**
174         * @return the consumer priority
175         */
176        @MBeanInfo("The subscription priority")
177        byte getPriority();
178    
179        /**
180         * @return the name of the consumer which is only used for durable
181         *         consumers.
182         */
183        @MBeanInfo("The name of the subscription (durable subscriptions only).")
184        String getSubcriptionName();
185    
186        /**
187         * Returns true if this subscription (which may be using wildcards) matches the given queue name
188         *
189         * @param queueName the JMS queue name to match against
190         * @return true if this subscription matches the given queue or false if not
191         */
192        @MBeanInfo("Returns true if the subscription (which may be using wildcards) matches the given queue name")
193        boolean isMatchingQueue(String queueName);
194    
195        /**
196         * Returns true if this subscription (which may be using wildcards) matches the given topic name
197         *
198         * @param topicName the JMS topic name to match against
199         * @return true if this subscription matches the given topic or false if not
200         */
201        @MBeanInfo("Returns true if the subscription (which may be using wildcards) matches the given topic name")
202        boolean isMatchingTopic(String topicName);
203    
204        /**
205         * Returns true if the subscription is slow
206         *
207         * @return true if the subscription is slow
208         */
209        @MBeanInfo("Returns true if the subscription is slow")
210        boolean isSlowConsumer();
211    
212        /**
213         * Returns the User Name used to authorize creation of this Subscription.
214         * This value can be null if display of user name information is disabled.
215         *
216         * @return the name of the user that created this Subscription
217         */
218        @MBeanInfo("User Name used to authorize creation of this Subscription")
219        String getUserName();
220    
221        /**
222         * Returns the ObjectName of the Connection that created this Subscription.
223         * This value can be null if for instance this is an off-line durable subscription.
224         *
225         * @return the name of the Connection that created this Subscription.
226         */
227        @MBeanInfo("ObjectName of the Connection that created this Subscription")
228        ObjectName getConnection();
229    
230    }