org.springframework.boot.actuate.autoconfigure.endpoint.condition.OnAvailableEndpointCondition Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-boot-actuator-autoconfigure Show documentation
Spring Boot Actuator AutoConfigure
There is a newer version: 3.2.5
Show newest version
/*
 * 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.autoconfigure.endpoint.condition;

import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import org.springframework.boot.actuate.autoconfigure.endpoint.expose.IncludeExcludeEndpointFilter;
import org.springframework.boot.actuate.autoconfigure.endpoint.expose.IncludeExcludeEndpointFilter.DefaultIncludes;
import org.springframework.boot.actuate.endpoint.EndpointId;
import org.springframework.boot.actuate.endpoint.ExposableEndpoint;
import org.springframework.boot.autoconfigure.condition.ConditionMessage;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
import org.springframework.boot.cloud.CloudPlatform;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.util.ConcurrentReferenceHashMap;

/**
 * A condition that checks if an endpoint is available (i.e. enabled and exposed).
 *
 * @author Brian Clozel
 * @author Stephane Nicoll
 * @author Phillip Webb
 * @see ConditionalOnAvailableEndpoint
 */
class OnAvailableEndpointCondition extends AbstractEndpointCondition {

	private static final String JMX_ENABLED_KEY = "spring.jmx.enabled";

	private static final Map> exposuresCache = new ConcurrentReferenceHashMap<>();

	@Override
	public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
		ConditionOutcome enablementOutcome = getEnablementOutcome(context, metadata,
				ConditionalOnAvailableEndpoint.class);
		if (!enablementOutcome.isMatch()) {
			return enablementOutcome;
		}
		ConditionMessage message = enablementOutcome.getConditionMessage();
		Environment environment = context.getEnvironment();
		if (CloudPlatform.CLOUD_FOUNDRY.isActive(environment)) {
			return new ConditionOutcome(true, message.andCondition(ConditionalOnAvailableEndpoint.class)
					.because("application is running on Cloud Foundry"));
		}
		EndpointId id = EndpointId.of(environment,
				getEndpointAttributes(ConditionalOnAvailableEndpoint.class, context, metadata).getString("id"));
		Set exposures = getExposures(environment);
		for (Exposure exposure : exposures) {
			if (exposure.isExposed(id)) {
				return new ConditionOutcome(true,
						message.andCondition(ConditionalOnAvailableEndpoint.class)
								.because("marked as exposed by a 'management.endpoints." + exposure.getPrefix()
										+ ".exposure' property"));
			}
		}
		return new ConditionOutcome(false, message.andCondition(ConditionalOnAvailableEndpoint.class)
				.because("no 'management.endpoints' property marked it as exposed"));
	}

	private Set getExposures(Environment environment) {
		Set exposures = exposuresCache.get(environment);
		if (exposures == null) {
			exposures = new HashSet<>(2);
			if (environment.getProperty(JMX_ENABLED_KEY, Boolean.class, false)) {
				exposures.add(new Exposure(environment, "jmx", DefaultIncludes.JMX));
			}
			exposures.add(new Exposure(environment, "web", DefaultIncludes.WEB));
			exposuresCache.put(environment, exposures);
		}
		return exposures;
	}

	static class Exposure extends IncludeExcludeEndpointFilter> {

		private final String prefix;

		@SuppressWarnings({ "rawtypes", "unchecked" })
		Exposure(Environment environment, String prefix, DefaultIncludes defaultIncludes) {
			super((Class) ExposableEndpoint.class, environment, "management.endpoints." + prefix + ".exposure",
					defaultIncludes);
			this.prefix = prefix;
		}

		String getPrefix() {
			return this.prefix;
		}

		boolean isExposed(EndpointId id) {
			return super.match(id);
		}

	}

}