netflix.karyon.health.HealthCheckHandler Maven / Gradle / Ivy
/*
* Copyright 2013 Netflix, Inc.
*
* 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 netflix.karyon.health;
/**
* This is an extension to the callback handler
* in eureka to provide a
* more flexible health check response (an HTTP status code) as a healthcheck request.
*
* This healthcheck handler is also used to have a fixed healthcheck endpoint created by karyon.
*
* @author Nitesh Kant
*/
public interface HealthCheckHandler {
/**
* Checks the health of the application and returns a status code, which can be directly consumed as a HTTP status
* code.
* Kayon considers any status code >= 200 and < 300 as healthy.
*
* @return The health status of the application.
*/
int getStatus();
}