HealthCheckContributor.java

/**
 * Copyright 2016-2017 Sixt GmbH & Co. Autovermietung KG
 * 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.sixt.service.framework.health;

/**
 * Interface for a contributor to the service's health status.
 * This is the polling flavor.  It will be called every few seconds.
 * There is also an on-demand flavor.  TBD
 */
public interface HealthCheckContributor {

    HealthCheck getHealthCheck();

    /**
     * Give a check the chance to initialize and then make a choice about whether
     * it will participate.
     */
    boolean shouldRegister();

}