org.springframework.http.server

Class DefaultRequestPath

java.lang.Object

org.springframework.http.server.DefaultRequestPath

All Implemented Interfaces:

PathContainer, RequestPath

class DefaultRequestPath
extends java.lang.Object
implements RequestPath

Default implementation of RequestPath.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.http.server.PathContainer

PathContainer.Element, PathContainer.PathSegment, PathContainer.Separator

Field Summary

Fields

Modifier and Type	Field and Description
private PathContainer	contextPath
private PathContainer	fullPath
private PathContainer	pathWithinApplication

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DefaultRequestPath(RequestPath requestPath, java.lang.String contextPath)
(package private)	DefaultRequestPath(java.net.URI uri, java.lang.String contextPath)

Method Summary

Modifier and Type	Method and Description
PathContainer	contextPath() Returns the portion of the URL path that represents the application.
java.util.List<PathContainer.Element>	elements() The list of path elements, either PathContainer.Separator or PathContainer.PathSegment.
boolean	equals(java.lang.Object other)
private static PathContainer	extractPathWithinApplication(PathContainer fullPath, PathContainer contextPath)
int	hashCode()
private static PathContainer	initContextPath(PathContainer path, java.lang.String contextPath)
RequestPath	modifyContextPath(java.lang.String contextPath) Return a new RequestPath instance with a modified context path.
PathContainer	pathWithinApplication() The portion of the request path after the context path.
java.lang.String	toString()
private static void	validateContextPath(java.lang.String fullPath, java.lang.String contextPath)
java.lang.String	value() The original (raw, encoded) path that this instance was parsed from.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.http.server.RequestPath

parse

Methods inherited from interface org.springframework.http.server.PathContainer

parsePath, subPath, subPath

Field Detail

fullPath

private final PathContainer fullPath

contextPath

private final PathContainer contextPath

pathWithinApplication

private final PathContainer pathWithinApplication

Constructor Detail

DefaultRequestPath

DefaultRequestPath(java.net.URI uri,
                   @Nullable
                   java.lang.String contextPath)

DefaultRequestPath

private DefaultRequestPath(RequestPath requestPath,
                           java.lang.String contextPath)

Method Detail

initContextPath

private static PathContainer initContextPath(PathContainer path,
                                             @Nullable
                                             java.lang.String contextPath)

validateContextPath

private static void validateContextPath(java.lang.String fullPath,
                                        java.lang.String contextPath)

extractPathWithinApplication

private static PathContainer extractPathWithinApplication(PathContainer fullPath,
                                                          PathContainer contextPath)

value

public java.lang.String value()

Description copied from interface: PathContainer

The original (raw, encoded) path that this instance was parsed from.

Specified by:

value in interface PathContainer

elements

public java.util.List<PathContainer.Element> elements()

Description copied from interface: PathContainer

The list of path elements, either PathContainer.Separator or PathContainer.PathSegment.

Specified by:

elements in interface PathContainer

contextPath

public PathContainer contextPath()

Description copied from interface: RequestPath

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 ContextPathCompositeHandler.

Specified by:

contextPath in interface RequestPath

pathWithinApplication

public PathContainer pathWithinApplication()

Description copied from interface: RequestPath

The portion of the request path after the context path.

Specified by:

pathWithinApplication in interface RequestPath

modifyContextPath

public RequestPath modifyContextPath(java.lang.String contextPath)

Description copied from interface: RequestPath

Return a new RequestPath instance with a modified context path. The new context path must match 0 or more path segments at the start.

Specified by:

modifyContextPath in interface RequestPath

Parameters:

contextPath - the new context path

Returns:

a new RequestPath instance

equals

public boolean equals(@Nullable
                      java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object