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;
020
021import javax.management.openmbean.TabularData;
022
023import org.apache.camel.api.management.ManagedAttribute;
024import org.apache.camel.api.management.ManagedOperation;
025
026public interface ManagedCamelHealthMBean {
027
028    @ManagedAttribute(description = "Whether Health Check is enabled globally")
029    boolean isEnabled();
030
031    @ManagedAttribute(description = "Application Health (all checks)")
032    boolean isHealthy();
033
034    @ManagedAttribute(description = "Application Health (only readiness checks)")
035    boolean isHealthyReadiness();
036
037    @ManagedAttribute(description = "Application Health (only liveness checks)")
038    boolean isHealthyLiveness();
039
040    @ManagedAttribute(description = "Registered Health Checks IDs")
041    Collection<String> getHealthChecksIDs();
042
043    @ManagedOperation(description = "Registered Health Checks Details")
044    TabularData details();
045
046    @ManagedOperation(description = "Invoke an Health Check by ID")
047    String invoke(String id);
048
049    @ManagedOperation(description = "Enables an Health Check by ID")
050    void enableById(String id);
051
052    @ManagedOperation(description = "Disables an Health Check by ID")
053    void disableById(String id);
054
055}