org.springframework.web.util

Class DefaultUriTemplateHandler

java.lang.Object

org.springframework.web.util.DefaultUriTemplateHandler

All Implemented Interfaces:

UriTemplateHandler

public class DefaultUriTemplateHandler
extends Object
implements UriTemplateHandler

Default implementation of UriTemplateHandler that relies on UriComponentsBuilder internally.

Since:

4.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
DefaultUriTemplateHandler()

Method Summary

Modifier and Type	Method and Description
URI	expand(String uriTemplate, Map<String,?> uriVariables) Expand the give URI template with a map of URI variables.
URI	expand(String uriTemplate, Object... uriVariableValues) Expand the give URI template with an array of URI variable values.
String	getBaseUrl() Return the configured base URL.
protected UriComponentsBuilder	initUriComponentsBuilder(String uriTemplate)
protected URI	insertBaseUrl(UriComponents uriComponents)
void	setBaseUrl(String baseUrl) Configure a base URL to prepend URI templates with.
void	setParsePath(boolean parsePath) Whether to parse the path of a URI template string into path segments.
boolean	shouldParsePath() Whether the handler is configured to parse the path into path segments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultUriTemplateHandler

public DefaultUriTemplateHandler()

Method Detail

setBaseUrl

public void setBaseUrl(String baseUrl)

Configure a base URL to prepend URI templates with. The base URL should have a scheme and host but may also contain a port and a partial path. Individual URI templates then may provide the remaining part of the URL including additional path, query and fragment.

Note: Individual URI templates are expanded and encoded before being appended to the base URL. Therefore the base URL is expected to be fully expanded and encoded, which can be done with the help of UriComponentsBuilder.

Parameters:

baseUrl - the base URL.

getBaseUrl

public String getBaseUrl()

Return the configured base URL.

setParsePath

public void setParsePath(boolean parsePath)

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

If set to true the path of parsed URI templates is decomposed into path segments so that URI variables expanded into the path are treated according to path segment encoding rules. In effect that means the "/" character is 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.

Parameters:

parsePath - whether to parse the path into path segments

shouldParsePath

public boolean shouldParsePath()

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

expand

public URI expand(String uriTemplate,
                  Map<String,?> uriVariables)

Description copied from interface: UriTemplateHandler

Expand the give URI template with a map of URI variables.

Specified by:

expand in interface UriTemplateHandler

Parameters:

uriTemplate - the URI template string

uriVariables - the URI variables

Returns:

the resulting URI

expand

public URI expand(String uriTemplate,
                  Object... uriVariableValues)

Description copied from interface: UriTemplateHandler

Expand the give URI template with an array of URI variable values.

Specified by:

expand in interface UriTemplateHandler

Parameters:

uriTemplate - the URI template string

uriVariableValues - the URI variable values

Returns:

the resulting URI

initUriComponentsBuilder

protected UriComponentsBuilder initUriComponentsBuilder(String uriTemplate)

insertBaseUrl

protected URI insertBaseUrl(UriComponents uriComponents)