org.springframework.web.util

Class UriComponents

java.lang.Object

org.springframework.web.util.UriComponents

All Implemented Interfaces:

java.io.Serializable

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, Juergen Hoeller, Rossen Stoyanchev

See Also:

UriComponentsBuilder, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UriComponents.UriTemplateVariables Defines the contract for URI Template variables

Constructor Summary

Constructors

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

Method Summary

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.nio.charset.Charset charset) 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.
java.lang.String	getFragment() Return the fragment.
abstract java.lang.String	getHost() Return the host.
abstract java.lang.String	getPath() Return the path.
abstract java.util.List<java.lang.String>	getPathSegments() Return the list of path segments.
abstract int	getPort() Return the port.
abstract java.lang.String	getQuery() Return the query.
abstract MultiValueMap<java.lang.String,java.lang.String>	getQueryParams() Return the map of query parameters.
java.lang.String	getScheme() Return the scheme.
abstract java.lang.String	getSchemeSpecificPart() Return the scheme specific part.
abstract java.lang.String	getUserInfo() Return the user info.
abstract UriComponents	normalize() Normalize the path removing sequences like "path/..".
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

Constructor Detail

UriComponents

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

Method Detail

getScheme

@Nullable
public final java.lang.String getScheme()

Return the scheme. Can be null.

getFragment

@Nullable
public final java.lang.String getFragment()

Return the fragment. Can be null.

getSchemeSpecificPart

@Nullable
public abstract java.lang.String getSchemeSpecificPart()

Return the scheme specific part. Can be null.

getUserInfo

@Nullable
public abstract java.lang.String getUserInfo()

Return the user info. Can be null.

getHost

@Nullable
public abstract java.lang.String getHost()

Return the host. Can be null.

getPort

public abstract int getPort()

Return the port. -1 if no port has been set.

getPath

@Nullable
public abstract java.lang.String getPath()

Return the path. Can be null.

getPathSegments

public abstract java.util.List<java.lang.String> getPathSegments()

Return the list of path segments. Empty if no path has been set.

getQuery

@Nullable
public abstract java.lang.String getQuery()

Return the query. Can be null.

getQueryParams

public abstract MultiValueMap<java.lang.String,java.lang.String> getQueryParams()

Return the map of query parameters. Empty if no query has been set.

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.nio.charset.Charset charset)

Encode all URI components using their specific encoding rules, and returns the result as a new UriComponents instance.

Parameters:

charset - the encoding of the values contained in this map

Returns:

the encoded URI components

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

normalize

public abstract UriComponents normalize()

Normalize the path removing sequences like "path/..". Note that calling this method will combine all path segments into a full path before doing the actual normalisation, i.e. individual path segments will not be normalized individually.

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