spring-framework / org.springframework.web.util / DefaultUriTemplateHandler

DefaultUriTemplateHandler

open class DefaultUriTemplateHandler : AbstractUriTemplateHandler

Default implementation of UriTemplateHandler based on the use of UriComponentsBuilder for expanding and encoding variables.

There are also several properties to customize how URI template handling is performed, including a baseUrl to be used as a prefix for all URI templates and a couple of encoding related options — parsePath and strictEncoding respectively.

Author
Rossen Stoyanchev

Since
4.2

Constructors

<init>

DefaultUriTemplateHandler()

Default implementation of UriTemplateHandler based on the use of UriComponentsBuilder for expanding and encoding variables.

There are also several properties to customize how URI template handling is performed, including a baseUrl to be used as a prefix for all URI templates and a couple of encoding related options — parsePath and strictEncoding respectively.

Functions

isStrictEncoding

open fun isStrictEncoding(): Boolean

Whether to strictly encode any character outside the unreserved set.

setParsePath

open fun setParsePath(parsePath: Boolean): Unit

Whether to parse the path of a URI template string into path segments.

If set to true the URI template path is immediately decomposed into path segments any URI variables expanded into it are then subject to path segment encoding rules. In effect URI variables in the path have any "/" characters percent encoded.

By default this is set to false in which case the path is kept as a full path and expanded URI variables will preserve "/" characters.

setStrictEncoding

open fun setStrictEncoding(strictEncoding: Boolean): Unit

Whether to encode characters outside the unreserved set as defined in RFC 3986 Section 2. This ensures a URI variable value will not contain any characters with a reserved purpose.

By default this is set to false in which case only characters illegal for the given URI component are encoded. For example when expanding a URI variable into a path segment the "/" character is illegal and encoded. The ";" character however is legal and not encoded even though it has a reserved purpose.

Note: this property supersedes the need to also set the parsePath property.

shouldParsePath

open fun shouldParsePath(): Boolean

Whether the handler is configured to parse the path into path segments.