From 15b8d598bd6d63faa5e7c071f6f4a5240c2aece7 Mon Sep 17 00:00:00 2001 From: Oliver Drotbohm Date: Wed, 29 Jul 2020 12:27:31 +0200 Subject: [PATCH] DATAREST-1540 - Tweak HandlerMapping setup to retain compatibility with 5.3. Turns out that Spring Boot references DelegatingHandlerMapping from its metrics integration to pick up the HandlerMappings delegated to. Reintroduced the relevant type in deprecated form and also let it implement Iterable so that client code can be moved to generally check for HandlerMappings implementing that and pick up the delegates that way. --- .../config/DelegatingHandlerMapping.java | 13 ++++++- .../support/DelegatingHandlerMapping.java | 39 +++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/support/DelegatingHandlerMapping.java diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/config/DelegatingHandlerMapping.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/config/DelegatingHandlerMapping.java index 7ed37d650..a20917a97 100644 --- a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/config/DelegatingHandlerMapping.java +++ b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/config/DelegatingHandlerMapping.java @@ -19,6 +19,7 @@ import lombok.Getter; import lombok.NonNull; import lombok.Value; +import java.util.Iterator; import java.util.List; import javax.servlet.http.HttpServletRequest; @@ -43,7 +44,8 @@ import org.springframework.web.util.pattern.PathPatternParser; * @author Oliver Gierke * @soundtrack Benny Greb - Stabila (Moving Parts) */ -class DelegatingHandlerMapping extends AbstractHandlerMapping implements MatchableHandlerMapping { +class DelegatingHandlerMapping extends AbstractHandlerMapping + implements org.springframework.data.rest.webmvc.support.DelegatingHandlerMapping { private final @Getter List delegates; @@ -70,6 +72,15 @@ class DelegatingHandlerMapping extends AbstractHandlerMapping implements Matchab .forEach(it -> it.setPatternParser(parser)); } + /* + * (non-Javadoc) + * @see java.lang.Iterable#iterator() + */ + @Override + public Iterator iterator() { + return delegates.iterator(); + } + /* * (non-Javadoc) * @see org.springframework.core.Ordered#getOrder() diff --git a/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/support/DelegatingHandlerMapping.java b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/support/DelegatingHandlerMapping.java new file mode 100644 index 000000000..da56e94d7 --- /dev/null +++ b/spring-data-rest-webmvc/src/main/java/org/springframework/data/rest/webmvc/support/DelegatingHandlerMapping.java @@ -0,0 +1,39 @@ +/* + * Copyright 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.data.rest.webmvc.support; + +import java.util.List; + +import org.springframework.web.servlet.HandlerMapping; +import org.springframework.web.servlet.handler.MatchableHandlerMapping; + +/** + * A {@link HandlerMapping} that exposes its delegates. + * + * @author Oliver Drotbohm + * @deprecated since 3.4. Prefer handling {@link HandlerMapping}s that implement {@link Iterable} of + * {@link HandlerMapping} and consume the delegates that way. + */ +@Deprecated +public interface DelegatingHandlerMapping extends MatchableHandlerMapping, Iterable { + + /** + * Returns all delegate {@link HandlerMapping}s. Prefer simply iterating over this instance itself. + * + * @return will never be {@literal null}. + */ + List getDelegates(); +}