org.springframework.boot.actuate.web.mappings.MappingsEndpoint Maven / Gradle / Ivy

/*
 * 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.web.mappings;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.context.ApplicationContext;

/**
 * {@link Endpoint} to expose HTTP request mappings.
 *
 * @author Andy Wilkinson
 * @since 2.0.0
 */
@Endpoint(id = "mappings")
public class MappingsEndpoint {

	private final Collection descriptionProviders;

	private final ApplicationContext context;

	public MappingsEndpoint(Collection descriptionProviders,
			ApplicationContext context) {
		this.descriptionProviders = descriptionProviders;
		this.context = context;
	}

	@ReadOperation
	public ApplicationMappings mappings() {
		ApplicationContext target = this.context;
		Map contextMappings = new HashMap<>();
		while (target != null) {
			contextMappings.put(target.getId(), mappingsForContext(target));
			target = target.getParent();
		}
		return new ApplicationMappings(contextMappings);
	}

	private ContextMappings mappingsForContext(ApplicationContext applicationContext) {
		Map mappings = new HashMap<>();
		this.descriptionProviders
				.forEach((provider) -> mappings.put(provider.getMappingName(),
						provider.describeMappings(applicationContext)));
		return new ContextMappings(mappings, (applicationContext.getParent() != null)
				? applicationContext.getId() : null);
	}

	/**
	 * A description of an application's request mappings. Primarily intended for
	 * serialization to JSON.
	 */
	public static final class ApplicationMappings {

		private final Map contextMappings;

		private ApplicationMappings(Map contextMappings) {
			this.contextMappings = contextMappings;
		}

		public Map getContexts() {
			return this.contextMappings;
		}

	}

	/**
	 * A description of an application context's request mappings. Primarily intended for
	 * serialization to JSON.
	 */
	public static final class ContextMappings {

		private final Map mappings;

		private final String parentId;

		private ContextMappings(Map mappings, String parentId) {
			this.mappings = mappings;
			this.parentId = parentId;
		}

		public String getParentId() {
			return this.parentId;
		}

		public Map getMappings() {
			return this.mappings;
		}

	}

}