org.springframework.boot.actuate.health.HealthEndpointWebExtension Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-boot-actuator Show documentation
Spring Boot Actuator
There is a newer version: 3.2.5
/*
 * Copyright 2012-2018 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.function.Supplier;

import org.springframework.boot.actuate.endpoint.SecurityContext;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.Selector;
import org.springframework.boot.actuate.endpoint.web.WebEndpointResponse;
import org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension;

/**
 * {@link EndpointWebExtension} for the {@link HealthEndpoint}.
 *
 * @author Christian Dupuis
 * @author Dave Syer
 * @author Andy Wilkinson
 * @author Phillip Webb
 * @author Eddú Meléndez
 * @author Madhura Bhave
 * @author Stephane Nicoll
 * @since 2.0.0
 */
@EndpointWebExtension(endpoint = HealthEndpoint.class)
public class HealthEndpointWebExtension {

	private final HealthEndpoint delegate;

	private final HealthWebEndpointResponseMapper responseMapper;

	public HealthEndpointWebExtension(HealthEndpoint delegate,
			HealthWebEndpointResponseMapper responseMapper) {
		this.delegate = delegate;
		this.responseMapper = responseMapper;
	}

	@ReadOperation
	public WebEndpointResponse health(SecurityContext securityContext) {
		return this.responseMapper.map(this.delegate.health(), securityContext);
	}

	@ReadOperation
	public WebEndpointResponse healthForComponent(SecurityContext securityContext,
			@Selector String component) {
		Supplier health = () -> this.delegate.healthForComponent(component);
		return this.responseMapper.mapDetails(health, securityContext);
	}

	@ReadOperation
	public WebEndpointResponse healthForComponentInstance(
			SecurityContext securityContext, @Selector String component,
			@Selector String instance) {
		Supplier health = () -> this.delegate
				.healthForComponentInstance(component, instance);
		return this.responseMapper.mapDetails(health, securityContext);
	}

	public WebEndpointResponse getHealth(SecurityContext securityContext,
			ShowDetails showDetails) {
		return this.responseMapper.map(this.delegate.health(), securityContext,
				showDetails);
	}

}