org.springframework.boot.actuate.web.mappings.servlet.DispatcherServletsMappingDescriptionProvider 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.servlet;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.servlet.Servlet;
import org.springframework.boot.actuate.web.mappings.HandlerMethodDescription;
import org.springframework.boot.actuate.web.mappings.MappingDescriptionProvider;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.ApplicationContext;
import org.springframework.data.rest.webmvc.support.DelegatingHandlerMapping;
import org.springframework.util.ClassUtils;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.DispatcherServlet;
import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.handler.AbstractUrlHandlerMapping;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
/**
* A {@link MappingDescriptionProvider} that introspects the {@link HandlerMapping
* HandlerMappings} that are known to one or more {@link DispatcherServlet
* DispatcherServlets}.
*
* @author Andy Wilkinson
* @author Stephane Nicoll
* @since 2.0.0
*/
public class DispatcherServletsMappingDescriptionProvider
implements MappingDescriptionProvider {
private static final List> descriptionProviders;
static {
List> providers = new ArrayList<>();
providers.add(new RequestMappingInfoHandlerMappingDescriptionProvider());
providers.add(new UrlHandlerMappingDescriptionProvider());
if (ClassUtils.isPresent(
"org.springframework.data.rest.webmvc.support.DelegatingHandlerMapping",
null)) {
providers.add(new DelegatingHandlerMappingDescriptionProvider(
new ArrayList<>(providers)));
}
descriptionProviders = Collections.unmodifiableList(providers);
}
@Override
public String getMappingName() {
return "dispatcherServlets";
}
@Override
public Map> describeMappings(
ApplicationContext context) {
if (context instanceof WebApplicationContext) {
return describeMappings((WebApplicationContext) context);
}
return Collections.emptyMap();
}
private Map> describeMappings(
WebApplicationContext context) {
Map> mappings = new HashMap<>();
determineDispatcherServlets(context).forEach((name, dispatcherServlet) -> mappings
.put(name, describeMappings(new DispatcherServletHandlerMappings(name,
dispatcherServlet, context))));
return mappings;
}
private Map determineDispatcherServlets(
WebApplicationContext context) {
Map dispatcherServlets = new LinkedHashMap<>();
context.getBeansOfType(ServletRegistrationBean.class).values()
.forEach((registration) -> {
Servlet servlet = registration.getServlet();
if (servlet instanceof DispatcherServlet
&& !dispatcherServlets.containsValue(servlet)) {
dispatcherServlets.put(registration.getServletName(),
(DispatcherServlet) servlet);
}
});
context.getBeansOfType(DispatcherServlet.class)
.forEach((name, dispatcherServlet) -> {
if (!dispatcherServlets.containsValue(dispatcherServlet)) {
dispatcherServlets.put(name, dispatcherServlet);
}
});
return dispatcherServlets;
}
private List describeMappings(
DispatcherServletHandlerMappings mappings) {
return mappings.getHandlerMappings().stream().flatMap(this::describe)
.collect(Collectors.toList());
}
private Stream describe(
T handlerMapping) {
return describe(handlerMapping, descriptionProviders).stream();
}
@SuppressWarnings("unchecked")
private static List describe(
T handlerMapping,
List> descriptionProviders) {
for (HandlerMappingDescriptionProvider descriptionProvider : descriptionProviders) {
if (descriptionProvider.getMappingClass().isInstance(handlerMapping)) {
return ((HandlerMappingDescriptionProvider) descriptionProvider)
.describe(handlerMapping);
}
}
return Collections.emptyList();
}
private interface HandlerMappingDescriptionProvider {
Class getMappingClass();
List describe(T handlerMapping);
}
private static final class RequestMappingInfoHandlerMappingDescriptionProvider
implements
HandlerMappingDescriptionProvider {
@Override
public Class getMappingClass() {
return RequestMappingInfoHandlerMapping.class;
}
@Override
public List describe(
RequestMappingInfoHandlerMapping handlerMapping) {
Map handlerMethods = handlerMapping
.getHandlerMethods();
return handlerMethods.entrySet().stream().map(this::describe)
.collect(Collectors.toList());
}
private DispatcherServletMappingDescription describe(
Entry mapping) {
DispatcherServletMappingDetails mappingDetails = new DispatcherServletMappingDetails();
mappingDetails
.setHandlerMethod(new HandlerMethodDescription(mapping.getValue()));
mappingDetails.setRequestMappingConditions(
new RequestMappingConditionsDescription(mapping.getKey()));
return new DispatcherServletMappingDescription(mapping.getKey().toString(),
mapping.getValue().toString(), mappingDetails);
}
}
private static final class UrlHandlerMappingDescriptionProvider
implements HandlerMappingDescriptionProvider {
@Override
public Class getMappingClass() {
return AbstractUrlHandlerMapping.class;
}
@Override
public List describe(
AbstractUrlHandlerMapping handlerMapping) {
return handlerMapping.getHandlerMap().entrySet().stream().map(this::describe)
.collect(Collectors.toList());
}
private DispatcherServletMappingDescription describe(
Entry mapping) {
return new DispatcherServletMappingDescription(mapping.getKey(),
mapping.getValue().toString(), null);
}
}
private static final class DelegatingHandlerMappingDescriptionProvider
implements HandlerMappingDescriptionProvider {
private final List> descriptionProviders;
private DelegatingHandlerMappingDescriptionProvider(
List> descriptionProviders) {
this.descriptionProviders = descriptionProviders;
}
@Override
public Class getMappingClass() {
return DelegatingHandlerMapping.class;
}
@Override
public List describe(
DelegatingHandlerMapping handlerMapping) {
List descriptions = new ArrayList<>();
for (HandlerMapping delegate : handlerMapping.getDelegates()) {
descriptions.addAll(DispatcherServletsMappingDescriptionProvider
.describe(delegate, this.descriptionProviders));
}
return descriptions;
}
}
}