Class DefaultUriTemplateHandler
- java.lang.Object
- org.springframework.web.util.AbstractUriTemplateHandler
- org.springframework.web.util.DefaultUriTemplateHandler
- All Implemented Interfaces:
UriTemplateHandler
public class DefaultUriTemplateHandler extends AbstractUriTemplateHandler
Default implementation ofUriTemplateHandlerbased on the use ofUriComponentsBuilderfor expanding and encoding variables.There are also several properties to customize how URI template handling is performed, including a
baseUrlto be used as a prefix for all URI templates and a couple of encoding related options —parsePathandstrictEncodingrespectively.- Since:
- 4.2
- Author:
- Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description DefaultUriTemplateHandler()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected UriComponentsexpandAndEncode(UriComponentsBuilder builder, Object[] uriVariables)protected UriComponentsexpandAndEncode(UriComponentsBuilder builder, Map<String,?> uriVariables)protected URIexpandInternal(String uriTemplate, Object... uriVariables)Actually expand and encode the URI template.protected URIexpandInternal(String uriTemplate, Map<String,?> uriVariables)Actually expand and encode the URI template.protected UriComponentsBuilderinitUriComponentsBuilder(String uriTemplate)Create aUriComponentsBuilderfrom the URI template string.booleanisStrictEncoding()Whether to strictly encode any character outside the unreserved set.voidsetParsePath(boolean parsePath)Whether to parse the path of a URI template string into path segments.voidsetStrictEncoding(boolean strictEncoding)Whether to encode characters outside the unreserved set as defined in RFC 3986 Section 2.booleanshouldParsePath()Whether the handler is configured to parse the path into path segments.Methods inherited from class org.springframework.web.util.AbstractUriTemplateHandler
expand, expand, getBaseUrl, getDefaultUriVariables, setBaseUrl, setDefaultUriVariables
Constructor Detail
DefaultUriTemplateHandler
public DefaultUriTemplateHandler()
Method Detail
setParsePath
public void setParsePath(boolean parsePath)
Whether to parse the path of a URI template string into path segments.If set to
truethe 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
falsein 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.
setStrictEncoding
public void setStrictEncoding(boolean strictEncoding)
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
falsein 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
parsePathproperty.- Parameters:
strictEncoding- whether to perform strict encoding- Since:
- 4.3
isStrictEncoding
public boolean isStrictEncoding()
Whether to strictly encode any character outside the unreserved set.
expandInternal
protected URI expandInternal(String uriTemplate, Map<String,?> uriVariables)
Description copied from class:AbstractUriTemplateHandlerActually expand and encode the URI template.- Specified by:
expandInternalin classAbstractUriTemplateHandler
expandInternal
protected URI expandInternal(String uriTemplate, Object... uriVariables)
Description copied from class:AbstractUriTemplateHandlerActually expand and encode the URI template.- Specified by:
expandInternalin classAbstractUriTemplateHandler
initUriComponentsBuilder
protected UriComponentsBuilder initUriComponentsBuilder(String uriTemplate)
Create aUriComponentsBuilderfrom the URI template string. This implementation also breaks up the path into path segments depending on whetherparsePathis enabled.
expandAndEncode
protected UriComponents expandAndEncode(UriComponentsBuilder builder, Map<String,?> uriVariables)
expandAndEncode
protected UriComponents expandAndEncode(UriComponentsBuilder builder, Object[] uriVariables)