com.github.cafapi.common.api.HealthReporter Maven / Gradle / Ivy
/*
* Copyright 2015-2024 Open Text.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.cafapi.common.api;
/**
* Indicates this object can report on its health.
*/
public interface HealthReporter
{
/**
* @return the result of the liveness check
*/
default HealthResult livenessCheck() {
return HealthResult.RESULT_HEALTHY;
}
/**
* @return the result of the health (aka readiness) check
*/
HealthResult healthCheck();
}