/*
 * Copyright 2012-2020 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.boot.actuate.health;

import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Set;

Strategy used to aggregate Status instances.

This is required in order to combine subsystem states expressed through Health.getStatus() into one state for the entire system.

Author:Phillip Webb
Since:2.2.0
/** * Strategy used to aggregate {@link Status} instances. * <p> * This is required in order to combine subsystem states expressed through * {@link Health#getStatus()} into one state for the entire system. * * @author Phillip Webb * @since 2.2.0 */
@FunctionalInterface public interface StatusAggregator {
Return StatusAggregator instance using default ordering rules.
Returns:a StatusAggregator with default ordering rules.
Since:2.3.0
/** * Return {@link StatusAggregator} instance using default ordering rules. * @return a {@code StatusAggregator} with default ordering rules. * @since 2.3.0 */
static StatusAggregator getDefault() { return SimpleStatusAggregator.INSTANCE; }
Return the aggregate status for the given set of statuses.
Params:
  • statuses – the statuses to aggregate
Returns:the aggregate status
/** * Return the aggregate status for the given set of statuses. * @param statuses the statuses to aggregate * @return the aggregate status */
default Status getAggregateStatus(Status... statuses) { return getAggregateStatus(new LinkedHashSet<>(Arrays.asList(statuses))); }
Return the aggregate status for the given set of statuses.
Params:
  • statuses – the statuses to aggregate
Returns:the aggregate status
/** * Return the aggregate status for the given set of statuses. * @param statuses the statuses to aggregate * @return the aggregate status */
Status getAggregateStatus(Set<Status> statuses); }