/*
 * 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.Map;
import java.util.Set;

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.annotation.Selector.Match;
import org.springframework.boot.actuate.endpoint.http.ApiVersion;
import org.springframework.boot.actuate.endpoint.web.WebEndpointResponse;
import org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension;

Author:Christian Dupuis, Dave Syer, Andy Wilkinson, Phillip Webb, Eddú Meléndez, Madhura Bhave, Stephane Nicoll, Scott Frederick
Since:2.0.0
/** * {@link EndpointWebExtension @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 * @author Scott Frederick * @since 2.0.0 */
@EndpointWebExtension(endpoint = HealthEndpoint.class) public class HealthEndpointWebExtension extends HealthEndpointSupport<HealthContributor, HealthComponent> { private static final String[] NO_PATH = {};
Create a new HealthEndpointWebExtension instance.
Params:
  • registry – the health contributor registry
  • groups – the health endpoint groups
/** * Create a new {@link HealthEndpointWebExtension} instance. * @param registry the health contributor registry * @param groups the health endpoint groups */
public HealthEndpointWebExtension(HealthContributorRegistry registry, HealthEndpointGroups groups) { super(registry, groups); } @ReadOperation public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion, SecurityContext securityContext) { return health(apiVersion, securityContext, false, NO_PATH); } @ReadOperation public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion, SecurityContext securityContext, @Selector(match = Match.ALL_REMAINING) String... path) { return health(apiVersion, securityContext, false, path); } public WebEndpointResponse<HealthComponent> health(ApiVersion apiVersion, SecurityContext securityContext, boolean showAll, String... path) { HealthResult<HealthComponent> result = getHealth(apiVersion, securityContext, showAll, path); if (result == null) { return (Arrays.equals(path, NO_PATH)) ? new WebEndpointResponse<>(DEFAULT_HEALTH, WebEndpointResponse.STATUS_OK) : new WebEndpointResponse<>(WebEndpointResponse.STATUS_NOT_FOUND); } HealthComponent health = result.getHealth(); HealthEndpointGroup group = result.getGroup(); int statusCode = group.getHttpCodeStatusMapper().getStatusCode(health.getStatus()); return new WebEndpointResponse<>(health, statusCode); } @Override protected HealthComponent getHealth(HealthContributor contributor, boolean includeDetails) { return ((HealthIndicator) contributor).getHealth(includeDetails); } @Override protected HealthComponent aggregateContributions(ApiVersion apiVersion, Map<String, HealthComponent> contributions, StatusAggregator statusAggregator, boolean showComponents, Set<String> groupNames) { return getCompositeHealth(apiVersion, contributions, statusAggregator, showComponents, groupNames); } }