HealthCheck.java

/*
 * #%L
 * Wisdom-Framework
 * %%
 * Copyright (C) 2013 - 2014 Wisdom Framework
 * %%
 * 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.
 * #L%
 */
package org.wisdom.monitor.service;

/**
 * HealthCheck interface.
 * <p/>
 * It allows applications to register their own Heath Check.
 */
public interface HealthCheck {

    /**
     * @return The name of the check.
     */
    public String name();

    /**
     * @return the current state. {@literal false} denotes a broken state.
     * @throws Exception when a health check throw an exception, it denotes a broken state.
     */
    public boolean check() throws Exception;

}