org.springframework.web.util

Class DefaultUriBuilderFactory

java.lang.Object

org.springframework.web.util.DefaultUriBuilderFactory

All Implemented Interfaces:

UriBuilderFactory, UriTemplateHandler

public class DefaultUriBuilderFactory
extends Object
implements UriBuilderFactory

Default implementation of UriBuilderFactory providing options to pre-configure all UriBuilder instances with common properties such as a base URI, encoding mode, and default URI variables.

Uses UriComponentsBuilder for URI building.

Since:

5.0

Author:

Rossen Stoyanchev

See Also:

UriComponentsBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultUriBuilderFactory.EncodingMode

Constructor Summary

Constructors

Constructor and Description
DefaultUriBuilderFactory() Default constructor without a base URI.
DefaultUriBuilderFactory(String baseUriTemplate) Constructor with a base URI.
DefaultUriBuilderFactory(UriComponentsBuilder baseUri) Variant of DefaultUriBuilderFactory(String) with a UriComponentsBuilder.

Method Summary

Modifier and Type	Method and Description
UriBuilder	builder() Create a builder with default settings.
URI	expand(String uriTemplate, Map<String,?> uriVars) Expand the given URI template from a map of URI variables.
URI	expand(String uriTemplate, Object... uriVars) Expand the given URI template from an array of URI variables.
Map<String,?>	getDefaultUriVariables() Return the configured default URI variable values.
DefaultUriBuilderFactory.EncodingMode	getEncodingMode() Return the configured encoding mode.
void	setDefaultUriVariables(Map<String,?> defaultUriVariables) Provide default URI variable values to use when expanding URI templates with a Map of variables.
void	setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode) Specify the encoding mode to use when building URIs: URI_COMPONENT -- expand the URI variables first and then encode all URI component (e.g.
void	setParsePath(boolean parsePath) Whether to parse the path into path segments for the URI string passed into uriString(String) or one of the expand methods.
boolean	shouldParsePath() Whether the handler is configured to parse the path into path segments.
UriBuilder	uriString(String uriTemplate) Create a builder from the given URI template string.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUriBuilderFactory

public DefaultUriBuilderFactory()

Default constructor without a base URI.

The target address must be specified on each UriBuilder.

DefaultUriBuilderFactory

public DefaultUriBuilderFactory(String baseUriTemplate)

Constructor with a base URI.

The given URI template is parsed via UriComponentsBuilder.fromUriString(java.lang.String) and then applied as a base URI to every UriBuilder via UriComponentsBuilder.uriComponents(org.springframework.web.util.UriComponents) unless the UriBuilder itself was created with a URI template that already has a target address.

Parameters:

baseUriTemplate - the URI template to use a base URL

DefaultUriBuilderFactory

public DefaultUriBuilderFactory(UriComponentsBuilder baseUri)

Variant of DefaultUriBuilderFactory(String) with a UriComponentsBuilder.

Method Detail

setDefaultUriVariables

public void setDefaultUriVariables(@Nullable
                                   Map<String,?> defaultUriVariables)

Provide default URI variable values to use when expanding URI templates with a Map of variables.

Parameters:

defaultUriVariables - default URI variable values

getDefaultUriVariables

public Map<String,?> getDefaultUriVariables()

Return the configured default URI variable values.

setEncodingMode

public void setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)

Specify the encoding mode to use when building URIs:

• URI_COMPONENT -- expand the URI variables first and then encode all URI component (e.g. host, path, query, etc) according to the encoding rules for each individual component.
• VALUES_ONLY -- encode URI variable values only, prior to expanding them, using a "strict" encoding mode, i.e. encoding all 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.
• NONE -- in this mode no encoding is performed.

By default this is set to "URI_COMPONENT".

Parameters:

encodingMode - the encoding mode to use

getEncodingMode

public DefaultUriBuilderFactory.EncodingMode getEncodingMode()

Return the configured encoding mode.

setParsePath

public void setParsePath(boolean parsePath)

Whether to parse the path into path segments for the URI string passed into uriString(String) or one of the expand methods.

Setting this property to true ensures that URI variables expanded into the path are subject to path segment encoding rules and "/" characters are percent-encoded. If set to false the path is kept as a full path and expanded URI variables will have "/" characters preserved.

By default this is set to true.

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,?> uriVars)

Description copied from interface: UriTemplateHandler

Expand the given URI template from a map of URI variables.

Specified by:

expand in interface UriTemplateHandler

Parameters:

uriTemplate - the URI template string

uriVars - the URI variables

Returns:

the resulting URI

expand

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

Description copied from interface: UriTemplateHandler

Expand the given URI template from an array of URI variables.

Specified by:

expand in interface UriTemplateHandler

Parameters:

uriTemplate - the URI template string

uriVars - the URI variable values

Returns:

the resulting URI

uriString

public UriBuilder uriString(String uriTemplate)

Description copied from interface: UriBuilderFactory

Create a builder from the given URI template string. Implementations may further combine the URI template with a base URI.

Specified by:

uriString in interface UriBuilderFactory

Parameters:

uriTemplate - the URI template to use

Returns:

the builder instance

builder

public UriBuilder builder()

Description copied from interface: UriBuilderFactory

Create a builder with default settings.

Specified by:

builder in interface UriBuilderFactory

Returns:

the builder instance