org.springframework.web.filter.ServletRequestPathFilter Maven / Gradle / Ivy
/*
* Copyright 2002-2023 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.web.filter;
import java.io.IOException;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.http.server.RequestPath;
import org.springframework.web.util.ServletRequestPathUtils;
/**
* {@code Filter} that {@link ServletRequestPathUtils#parseAndCache parses and
* caches} a {@link org.springframework.http.server.RequestPath} that can then
* be accessed via {@link ServletRequestPathUtils#getParsedRequestPath}.
* Note: The {@code DispatcherServlet} already does the same,
* and therefore, this filter is mainly useful if you need to also have the
* parsed path available in the filter chain before and after the
* {@code DispatcherServlet}.
*
* @author Rossen Stoyanchev
* @since 5.3
*/
public class ServletRequestPathFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
RequestPath previousRequestPath = (RequestPath) request.getAttribute(ServletRequestPathUtils.PATH_ATTRIBUTE);
ServletRequestPathUtils.parseAndCache((HttpServletRequest) request);
try {
chain.doFilter(request, response);
}
finally {
ServletRequestPathUtils.setParsedRequestPath(previousRequestPath, request);
}
}
}