core/api/src/main/java/org/qi4j/api/metrics/MetricsHealthCheck.java

/*
 * Copyright (c) 2012, Niclas Hedhman. All Rights Reserved.
 *
 * 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 org.qi4j.api.metrics;

/**
 * Metrics Health Check.
 */
public interface MetricsHealthCheck extends Metric
{
    Result check()
        throws Exception;

    public final class Result
    {
        private final boolean healthy;
        private final String message;
        private final Throwable exception;

        public Result( boolean isHealthy, String message, Throwable exception )
        {
            healthy = isHealthy;
            this.message = message;
            this.exception = exception;
        }

        public boolean isHealthy()
        {
            return healthy;
        }

        public String getMessage()
        {
            return message;
        }

        public Throwable getException()
        {
            return exception;
        }
    }
}