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.camel.api.management.mbean;
018
019import java.util.Collection;
020import javax.management.openmbean.TabularData;
021
022import org.apache.camel.api.management.ManagedAttribute;
023import org.apache.camel.api.management.ManagedOperation;
024
025public interface ManagedCamelHealthMBean {
026    
027    @ManagedAttribute(description = "Application Health")
028    boolean getIsHealthy();
029
030    @ManagedAttribute(description = "Registered Health Checks IDs")
031    Collection<String> getHealthChecksIDs();
032
033    @ManagedOperation(description = "Registered Health Checks Details")
034    TabularData details();
035
036    @ManagedOperation(description = "Invoke an Health Check by ID")
037    String invoke(String id);
038}