Package org.apache.activemq.broker.jmx
Interface HealthViewMBean
-
- All Known Implementing Classes:
HealthView
public interface HealthViewMBean
Returns the status events of the broker to indicate any warnings.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getCurrentStatus()
Warning, this method only return a value if the health or healthList method has previously been called.TabularData
health()
List<HealthStatus>
healthList()
Warning this method can only be invoked if you have the correct version ofHealthStatus
on your classpath or you use something like jolokia to access JMX.String
healthStatus()
-
-
-
Method Detail
-
health
TabularData health() throws Exception
- Throws:
Exception
-
healthList
List<HealthStatus> healthList() throws Exception
Warning this method can only be invoked if you have the correct version ofHealthStatus
on your classpath or you use something like jolokia to access JMX. If in doubt, please use thegetCurrentStatus()
method instead!- Returns:
- a list of HealthStatus objects that describe the health of the Broker.
- Throws:
Exception
-
healthStatus
String healthStatus() throws Exception
- Returns:
- a String representation of current Broker health state.
- Throws:
Exception
-
getCurrentStatus
String getCurrentStatus()
Warning, this method only return a value if the health or healthList method has previously been called. The value is not updated on its own and requires periodic calls to the health or healthList methods to refresh its value.- Returns:
- String representation of the current Broker state
-
-