/*
 * Copyright 2012-present 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.grpc.server.health;

/**
 * A single gRPC component that can be checked for health.
 *
 * @author Phillip Webb
 * @since 4.1.0
 */
public interface HealthCheckedGrpcComponent {

	/**
	 * Returns {@code true} if the given health contributor is a member of this component.
	 * @param healthContributorName the contributor name
	 * @return {@code true} if the contributor is a member
	 */
	boolean isMember(String healthContributorName);

	/**
	 * Returns the status aggregator that should be used for this component.
	 * @return the status aggregator
	 */
	StatusAggregator getStatusAggregator();

	/**
	 * Returns the {@link StatusMapper} that should be used for this component.
	 * @return the status mapper
	 */
	StatusMapper getStatusMapper();

}
