org.springframework.http.server.RequestPath Maven / Gradle / Ivy
/*
* Copyright 2002-2021 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.http.server;
import java.net.URI;
import org.springframework.lang.Nullable;
/**
* Specialization of {@link PathContainer} that subdivides the path into a
* {@link #contextPath()} and the remaining {@link #pathWithinApplication()}.
* The latter is typically used for request mapping within the application
* while the former is useful when preparing external links that point back to
* the application.
*
* @author Rossen Stoyanchev
* @since 5.0
*/
public interface RequestPath extends PathContainer {
/**
* Returns the portion of the URL path that represents the application.
* The context path is always at the beginning of the path and starts but
* does not end with "/". It is shared for URLs of the same application.
* The context path may come from the underlying runtime API such as
* when deploying as a WAR to a Servlet container or it may be assigned in
* a WebFlux application through the use of
* {@link org.springframework.http.server.reactive.ContextPathCompositeHandler
* ContextPathCompositeHandler}.
*/
PathContainer contextPath();
/**
* The portion of the request path after the context path which is typically
* used for request mapping within the application .
*/
PathContainer pathWithinApplication();
/**
* Return a new {@code RequestPath} instance with a modified context path.
* The new context path must match 0 or more path segments at the start.
* @param contextPath the new context path
* @return a new {@code RequestPath} instance
*/
RequestPath modifyContextPath(String contextPath);
/**
* Parse the URI for a request into a {@code RequestPath}.
* @param uri the URI of the request
* @param contextPath the contextPath portion of the URI path
*/
static RequestPath parse(URI uri, @Nullable String contextPath) {
return parse(uri.getRawPath(), contextPath);
}
/**
* Variant of {@link #parse(URI, String)} with the encoded
* {@link URI#getRawPath() raw path}.
* @param rawPath the path
* @param contextPath the contextPath portion of the URI path
* @since 5.3
*/
static RequestPath parse(String rawPath, @Nullable String contextPath) {
return new DefaultRequestPath(rawPath, contextPath);
}
}