org.eclipse.edc.spi.system.health.HealthCheckResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of boot-spi Show documentation
edc :: boot-spi
The newest version!
/*
 *  Copyright (c) 2022 Microsoft Corporation
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Microsoft Corporation - Initial implementation
 *
 */

package org.eclipse.edc.spi.system.health;

import com.fasterxml.jackson.annotation.JsonProperty;
import org.eclipse.edc.spi.result.AbstractResult;
import org.eclipse.edc.spi.result.Failure;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * Represents the result of one single health check, like a heartbeat to a database or to a messaging service.
 */
public class HealthCheckResult extends AbstractResult {
    private String component;

    private HealthCheckResult(boolean successful, Failure failure) {
        super(successful, failure);
    }

    /*
     * @deprecated Use the Builder instead
     */
    @Deprecated(since = "0.7.0")
    public static HealthCheckResult success() {
        return new HealthCheckResult(true, null);
    }

    /*
     * @deprecated Use the Builder instead
     */
    @Deprecated(since = "0.7.0")
    public static HealthCheckResult failed(String... errors) {
        var errorList = Stream.of(errors).filter(Objects::nonNull).collect(Collectors.toList());
        return new HealthCheckResult(false, new Failure(errorList));
    }

    /*
     * @deprecated Use the Builder instead
     */
    @Deprecated(since = "0.7.0")
    public static HealthCheckResult failed(List errors) {
        return new HealthCheckResult(false, new Failure(errors));
    }

    @JsonProperty("isHealthy")
    @Override
    public @NotNull Boolean getContent() {
        return super.getContent();
    }

    @NotNull
    @SuppressWarnings("unchecked")
    @Override
    protected , C1> R1 newInstance(@Nullable C1 content, @Nullable Failure failure) {
        return (R1) new HealthCheckResult(failure == null, failure);
    }

    public String getComponent() {
        return component;
    }

    public HealthCheckResult forComponent(String component) {
        this.component = component;
        return this;
    }

    public static class Builder {
        private String component;
        private boolean success = true;
        private Failure failure;

        private Builder() {

        }

        public static Builder newInstance() {
            return new Builder();
        }

        public Builder success() {
            success = true;
            return this;
        }

        public Builder success(boolean success, String... errors) {
            this.success = success;
            if (!success) {
                return failure(errors);
            }
            return this;
        }

        public Builder failure(String... errors) {
            return failure(Arrays.asList(errors));
        }

        public Builder failure(Collection errors) {
            var errorList = errors.stream().filter(Objects::nonNull).toList();
            failure = new Failure(errorList);
            success = false;
            return this;
        }

        public Builder component(String component) {
            this.component = component;
            return this;
        }

        public HealthCheckResult build() {
            var hc = new HealthCheckResult(success, failure);
            hc.component = Objects.requireNonNull(component, "Component name cannot be null");
            return hc;
        }
    }


}