UriComponents

java.lang.Object
- org.springframework.web.util.UriComponents

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

HierarchicalUriComponents, OpaqueUriComponents
```
public abstract class UriComponents
extends java.lang.Object
implements java.io.Serializable
```
Represents an immutable collection of URI components, mapping component type to String values. Contains convenience getters for all components. Effectively similar to URI, but with more powerful encoding options and support for URI template variables.

Since:

3.1

Author:

Arjen Poutsma

See Also:

UriComponentsBuilder, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`UriComponents.MapTemplateVariables` URI template variables backed by a map.
`static interface`	`UriComponents.UriTemplateVariables` Defines the contract for URI Template variables
`private static class`	`UriComponents.VarArgsTemplateVariables` URI template variables backed by a variable argument array.

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`DEFAULT_ENCODING`
`private java.lang.String`	`fragment`
`private static java.util.regex.Pattern`	`NAMES_PATTERN` Captures URI template variable names.
`private java.lang.String`	`scheme`

Constructor Summary

Constructors
Modifier Constructor and Description

protected UriComponents(java.lang.String scheme, java.lang.String fragment)

Constructors
Modifier	Constructor and Description
`protected`	`UriComponents(java.lang.String scheme, java.lang.String fragment)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`copyToUriComponentsBuilder(UriComponentsBuilder builder)` Set all components of the given UriComponentsBuilder.
`UriComponents`	`encode()` Encode all URI components using their specific encoding rules, and returns the result as a new `UriComponents` instance.
`abstract UriComponents`	`encode(java.lang.String encoding)` Encode all URI components using their specific encoding rules, and returns the result as a new `UriComponents` instance.
`UriComponents`	`expand(java.util.Map<java.lang.String,?> uriVariables)` Replace all URI template variables with the values from a given map.
`UriComponents`	`expand(java.lang.Object... uriVariableValues)` Replace all URI template variables with the values from a given array.
`UriComponents`	`expand(UriComponents.UriTemplateVariables uriVariables)` Replace all URI template variables with the values from the given `UriComponents.UriTemplateVariables`.
`(package private) abstract UriComponents`	`expandInternal(UriComponents.UriTemplateVariables uriVariables)` Replace all URI template variables with the values from the given `UriComponents.UriTemplateVariables`
`(package private) static java.lang.String`	`expandUriComponent(java.lang.String source, UriComponents.UriTemplateVariables uriVariables)`
`java.lang.String`	`getFragment()` Returns the fragment.
`abstract java.lang.String`	`getHost()` Returns the host.
`abstract java.lang.String`	`getPath()` Returns the path.
`abstract java.util.List<java.lang.String>`	`getPathSegments()` Returns the list of path segments.
`abstract int`	`getPort()` Returns the port.
`abstract java.lang.String`	`getQuery()` Returns the query.
`abstract MultiValueMap<java.lang.String,java.lang.String>`	`getQueryParams()` Returns the map of query parameters.
`java.lang.String`	`getScheme()` Returns the scheme.
`abstract java.lang.String`	`getSchemeSpecificPart()` Returns the scheme specific part.
`abstract java.lang.String`	`getUserInfo()` Returns the user info.
`private static java.lang.String`	`getVariableName(java.lang.String match)`
`private static java.lang.String`	`getVariableValueAsString(java.lang.Object variableValue)`
`abstract UriComponents`	`normalize()` Normalize the path removing sequences like "path/..".
`private static java.lang.String`	`sanitizeSource(java.lang.String source)` Remove nested "{}" such as in URI vars with regular expressions.
`java.lang.String`	`toString()`
`abstract java.net.URI`	`toUri()` Return a `URI` from this `UriComponents` instance.
`abstract java.lang.String`	`toUriString()` Return a URI string from this `UriComponents` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_ENCODING
```
private static final java.lang.String DEFAULT_ENCODING
```
    See Also:
    
    Constant Field Values
  - NAMES_PATTERN
```
private static final java.util.regex.Pattern NAMES_PATTERN
```
    Captures URI template variable names.
  - scheme
```
private final java.lang.String scheme
```
  - fragment
```
private final java.lang.String fragment
```
- Constructor Detail
  - UriComponents
```
protected UriComponents(java.lang.String scheme,
                        java.lang.String fragment)
```
- Method Detail
  - getScheme
```
public final java.lang.String getScheme()
```
    Returns the scheme. Can be null.
  - getSchemeSpecificPart
```
public abstract java.lang.String getSchemeSpecificPart()
```
    Returns the scheme specific part. Can be null.
  - getUserInfo
```
public abstract java.lang.String getUserInfo()
```
    Returns the user info. Can be null.
  - getHost
```
public abstract java.lang.String getHost()
```
    Returns the host. Can be null.
  - getPort
```
public abstract int getPort()
```
    Returns the port. Returns -1 if no port has been set.
  - getPath
```
public abstract java.lang.String getPath()
```
    Returns the path. Can be null.
  - getPathSegments
```
public abstract java.util.List<java.lang.String> getPathSegments()
```
    Returns the list of path segments. Empty if no path has been set.
  - getQuery
```
public abstract java.lang.String getQuery()
```
    Returns the query. Can be null.
  - getQueryParams
```
public abstract MultiValueMap<java.lang.String,java.lang.String> getQueryParams()
```
    Returns the map of query parameters. Empty if no query has been set.
  - getFragment
```
public final java.lang.String getFragment()
```
    Returns the fragment. Can be null.
  - encode
```
public final UriComponents encode()
```
    Encode all URI components using their specific encoding rules, and returns the result as a new UriComponents instance. This method uses UTF-8 to encode.
    
    Returns:
    
    the encoded URI components
  - encode
```
public abstract UriComponents encode(java.lang.String encoding)
                              throws java.io.UnsupportedEncodingException
```
    Encode all URI components using their specific encoding rules, and returns the result as a new UriComponents instance.
    
    Parameters:
    
    encoding - the encoding of the values contained in this map
    
    Returns:
    
    the encoded URI components
    
    Throws:
    
    java.io.UnsupportedEncodingException - if the given encoding is not supported
  - expand
```
public final UriComponents expand(java.util.Map<java.lang.String,?> uriVariables)
```
    Replace all URI template variables with the values from a given map.
    The given map keys represent variable names; the corresponding values represent variable values. The order of variables is not significant.
    
    Parameters:
    
    uriVariables - the map of URI variables
    
    Returns:
    
    the expanded URI components
  - expand
```
public final UriComponents expand(java.lang.Object... uriVariableValues)
```
    Replace all URI template variables with the values from a given array.
    The given array represents variable values. The order of variables is significant.
    
    Parameters:
    
    uriVariableValues - the URI variable values
    
    Returns:
    
    the expanded URI components
  - expand
```
public final UriComponents expand(UriComponents.UriTemplateVariables uriVariables)
```
    Replace all URI template variables with the values from the given UriComponents.UriTemplateVariables.
    
    Parameters:
    
    uriVariables - the URI template values
    
    Returns:
    
    the expanded URI components
  - expandInternal
```
abstract UriComponents expandInternal(UriComponents.UriTemplateVariables uriVariables)
```
    Replace all URI template variables with the values from the given UriComponents.UriTemplateVariables
    
    Parameters:
    
    uriVariables - URI template values
    
    Returns:
    
    the expanded uri components
  - normalize
```
public abstract UriComponents normalize()
```
    Normalize the path removing sequences like "path/..".
    
    See Also:
    
    StringUtils.cleanPath(String)
  - toUriString
```
public abstract java.lang.String toUriString()
```
    Return a URI string from this UriComponents instance.
  - toUri
```
public abstract java.net.URI toUri()
```
    Return a URI from this UriComponents instance.
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - copyToUriComponentsBuilder
```
protected abstract void copyToUriComponentsBuilder(UriComponentsBuilder builder)
```
    Set all components of the given UriComponentsBuilder.
    
    Since:
    
    4.2
  - expandUriComponent
```
static java.lang.String expandUriComponent(java.lang.String source,
                                           UriComponents.UriTemplateVariables uriVariables)
```
  - sanitizeSource
```
private static java.lang.String sanitizeSource(java.lang.String source)
```
    Remove nested "{}" such as in URI vars with regular expressions.
  - getVariableName
```
private static java.lang.String getVariableName(java.lang.String match)
```
  - getVariableValueAsString
```
private static java.lang.String getVariableValueAsString(java.lang.Object variableValue)
```

Class UriComponents

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENCODING

NAMES_PATTERN

scheme

fragment

Constructor Detail

UriComponents

Method Detail

getScheme

getSchemeSpecificPart

getUserInfo

getHost

getPort

getPath

getPathSegments

getQuery

getQueryParams

getFragment

encode

encode

expand

expand

expand

expandInternal

normalize

toUriString

toUri

toString

copyToUriComponentsBuilder

expandUriComponent

sanitizeSource

getVariableName

getVariableValueAsString