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.management.openmbean.TabularData;
020    import java.util.List;
021    
022    /**
023     * Returns the status events of the broker to indicate any warnings.
024     */
025    public interface HealthViewMBean {
026    
027        public TabularData health() throws Exception;
028    
029        /**
030         * Warning this method can only be invoked if you have the correct version
031         * of {@link HealthStatus} on your classpath or you use something
032         * like <a href="http://jolokia.org/">jolokia</a> to access JMX.
033         *
034         * If in doubt, please use the {@link #status()} method instead!
035         */
036        @MBeanInfo("List of warnings and errors about the current health of the Broker - empty list is Good!")
037        List<HealthStatus> healthList() throws Exception;
038    
039        /**
040         * @return  String representation of the current Broker state
041         */
042        @MBeanInfo("String representation of current Broker state")
043        String getCurrentStatus();
044    }