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 */
017package org.apache.activemq.broker.jmx;
018
019import javax.management.ObjectName;
020import javax.management.openmbean.OpenDataException;
021import javax.management.openmbean.TabularData;
022
023public interface AbortSlowConsumerStrategyViewMBean {
024    
025    @MBeanInfo("returns the current max slow count, -1 disables")
026    long getMaxSlowCount();
027
028    @MBeanInfo("sets the count after which a slow consumer will be aborted, -1 disables")
029    void setMaxSlowCount(long maxSlowCount);
030    
031    @MBeanInfo("returns the current max slow (milliseconds) duration")
032    long getMaxSlowDuration();
033
034    @MBeanInfo("sets the duration (milliseconds) after which a continually slow consumer will be aborted")
035    void setMaxSlowDuration(long maxSlowDuration);
036
037    @MBeanInfo("returns the check period at which a sweep of consumers is done to determine continued slowness")
038    public long getCheckPeriod();
039    
040    @MBeanInfo("returns the current list of slow consumers, Not HTML friendly")
041    TabularData getSlowConsumers() throws OpenDataException;
042    
043    @MBeanInfo("aborts the slow consumer gracefully by sending a shutdown control message to just that consumer")
044    void abortConsumer(ObjectName consumerToAbort);
045    
046    @MBeanInfo("aborts the slow consumer forcefully by shutting down it's connection, note: all other users of the connection will be affected")
047    void abortConnection(ObjectName consumerToAbort);
048
049    @MBeanInfo("aborts the slow consumer gracefully by sending a shutdown control message to just that consumer")
050    void abortConsumer(String objectNameOfConsumerToAbort);
051    
052    @MBeanInfo("aborts the slow consumer forcefully by shutting down it's connection, note: all other users of the connection will be affected")
053    void abortConnection(String objectNameOfConsumerToAbort);
054}