org.springframework.web.util

Interface UriTemplateHandler

All Known Implementing Classes:

AbstractUriTemplateHandler, DefaultUriTemplateHandler

public interface UriTemplateHandler

Strategy for expanding a URI template with full control over the URI template syntax and the encoding of variables. Also a convenient central point for pre-processing all URI templates for example to insert a common base path.

Supported as a property on the RestTemplate as well as the AsyncRestTemplate. The DefaultUriTemplateHandler is built on Spring's URI template support via UriComponentsBuilder. An alternative implementation may be used to plug external URI template libraries.

Since:

4.2

Author:

Rossen Stoyanchev

See Also:

RestTemplate.setUriTemplateHandler(org.springframework.web.util.UriTemplateHandler)

Method Summary

Modifier and Type	Method and Description
java.net.URI	expand(java.lang.String uriTemplate, java.util.Map<java.lang.String,?> uriVariables) Expand the given URI template from a map of URI variables.
java.net.URI	expand(java.lang.String uriTemplate, java.lang.Object... uriVariables) Expand the given URI template from an array of URI variables.

Method Detail

expand

java.net.URI expand(java.lang.String uriTemplate,
                    java.util.Map<java.lang.String,?> uriVariables)

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

Parameters:

uriTemplate - the URI template string

uriVariables - the URI variables

Returns:

the resulting URI

expand

java.net.URI expand(java.lang.String uriTemplate,
                    java.lang.Object... uriVariables)

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

Parameters:

uriTemplate - the URI template string

uriVariables - the URI variable values

Returns:

the resulting URI