org.springframework.web.util

Class HierarchicalUriComponents

java.lang.Object

org.springframework.web.util.UriComponents

org.springframework.web.util.HierarchicalUriComponents

All Implemented Interfaces:

java.io.Serializable

final class HierarchicalUriComponents
extends UriComponents

Extension of UriComponents for hierarchical URIs.

Since:

3.1.3

Author:

Arjen Poutsma, Rossen Stoyanchev, Phillip Webb

See Also:

Hierarchical URIs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	HierarchicalUriComponents.FullPathComponent Represents a path backed by a string.
(package private) static interface	HierarchicalUriComponents.PathComponent Defines the contract for path (segments).
(package private) static class	HierarchicalUriComponents.PathComponentComposite Represents a collection of PathComponents.
(package private) static class	HierarchicalUriComponents.PathSegmentComponent Represents a path backed by a string list (i.e.
private static class	HierarchicalUriComponents.QueryUriTemplateVariables
(package private) static class	HierarchicalUriComponents.Type Enumeration used to identify the allowed characters per URI component.

Nested classes/interfaces inherited from class org.springframework.web.util.UriComponents

UriComponents.UriTemplateVariables

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	encoded
private java.lang.String	host
(package private) static HierarchicalUriComponents.PathComponent	NULL_PATH_COMPONENT Represents an empty path.
private HierarchicalUriComponents.PathComponent	path
private static char	PATH_DELIMITER
private java.lang.String	port
private MultiValueMap<java.lang.String,java.lang.String>	queryParams
private java.lang.String	userInfo

Constructor Summary

Constructors

Constructor and Description
HierarchicalUriComponents(java.lang.String scheme, java.lang.String userInfo, java.lang.String host, java.lang.String port, HierarchicalUriComponents.PathComponent path, MultiValueMap<java.lang.String,java.lang.String> queryParams, java.lang.String fragment, boolean encoded, boolean verify) Package-private constructor.

Method Summary

Modifier and Type	Method and Description
protected void	copyToUriComponentsBuilder(UriComponentsBuilder builder) Set all components of the given UriComponentsBuilder.
HierarchicalUriComponents	encode(java.lang.String encoding) Encode all URI components using their specific encoding rules and return the result as a new UriComponents instance.
private static byte[]	encodeBytes(byte[] source, HierarchicalUriComponents.Type type)
private MultiValueMap<java.lang.String,java.lang.String>	encodeQueryParams(java.lang.String encoding)
(package private) static java.lang.String	encodeUriComponent(java.lang.String source, java.lang.String encoding, HierarchicalUriComponents.Type type) Encode the given source into an encoded String using the rules specified by the given component and with the given options.
boolean	equals(java.lang.Object obj)
protected HierarchicalUriComponents	expandInternal(UriComponents.UriTemplateVariables uriVariables) Replace all URI template variables with the values from the given UriComponents.UriTemplateVariables
private MultiValueMap<java.lang.String,java.lang.String>	expandQueryParams(UriComponents.UriTemplateVariables variables)
java.lang.String	getHost() Returns the host.
private HierarchicalUriComponents.Type	getHostType()
java.lang.String	getPath() Returns the path.
java.util.List<java.lang.String>	getPathSegments() Returns the list of path segments.
int	getPort() Returns the port.
java.lang.String	getQuery() Returns the query.
MultiValueMap<java.lang.String,java.lang.String>	getQueryParams() Returns the map of query parameters.
java.lang.String	getSchemeSpecificPart() Returns the scheme specific part.
java.lang.String	getUserInfo() Returns the user info.
int	hashCode()
UriComponents	normalize() Normalize the path removing sequences like "path/..".
java.net.URI	toUri() Returns a URI from this UriComponents instance.
java.lang.String	toUriString() Returns a URI string from this UriComponents instance.
private void	verify() Verifies all URI components to determine whether they contain any illegal characters, throwing an IllegalArgumentException if so.
private static void	verifyUriComponent(java.lang.String source, HierarchicalUriComponents.Type type)

Methods inherited from class org.springframework.web.util.UriComponents

encode, expand, expand, expand, expandUriComponent, getFragment, getScheme, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PATH_DELIMITER

private static final char PATH_DELIMITER

See Also:

Constant Field Values

userInfo

private final java.lang.String userInfo

host

private final java.lang.String host

port

private final java.lang.String port

path

private final HierarchicalUriComponents.PathComponent path

queryParams

private final MultiValueMap<java.lang.String,java.lang.String> queryParams

encoded

private final boolean encoded

NULL_PATH_COMPONENT

static final HierarchicalUriComponents.PathComponent NULL_PATH_COMPONENT

Represents an empty path.

Constructor Detail

HierarchicalUriComponents

HierarchicalUriComponents(java.lang.String scheme,
                          java.lang.String userInfo,
                          java.lang.String host,
                          java.lang.String port,
                          HierarchicalUriComponents.PathComponent path,
                          MultiValueMap<java.lang.String,java.lang.String> queryParams,
                          java.lang.String fragment,
                          boolean encoded,
                          boolean verify)

Package-private constructor. All arguments are optional, and can be null.

Parameters:

scheme - the scheme

userInfo - the user info

host - the host

port - the port

path - the path

queryParams - the query parameters

fragment - the fragment

encoded - whether the components are already encoded

verify - whether the components need to be checked for illegal characters

Method Detail

getSchemeSpecificPart

public java.lang.String getSchemeSpecificPart()

Description copied from class: UriComponents

Returns the scheme specific part. Can be null.

Specified by:

getSchemeSpecificPart in class UriComponents

getUserInfo

public java.lang.String getUserInfo()

Description copied from class: UriComponents

Returns the user info. Can be null.

Specified by:

getUserInfo in class UriComponents

getHost

public java.lang.String getHost()

Description copied from class: UriComponents

Returns the host. Can be null.

Specified by:

getHost in class UriComponents

getPort

public int getPort()

Description copied from class: UriComponents

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

Specified by:

getPort in class UriComponents

getPath

public java.lang.String getPath()

Description copied from class: UriComponents

Returns the path. Can be null.

Specified by:

getPath in class UriComponents

getPathSegments

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

Description copied from class: UriComponents

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

Specified by:

getPathSegments in class UriComponents

getQuery

public java.lang.String getQuery()

Description copied from class: UriComponents

Returns the query. Can be null.

Specified by:

getQuery in class UriComponents

getQueryParams

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

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

Specified by:

getQueryParams in class UriComponents

encode

public HierarchicalUriComponents encode(java.lang.String encoding)
                                 throws java.io.UnsupportedEncodingException

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

Specified by:

encode in class UriComponents

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

encodeQueryParams

private MultiValueMap<java.lang.String,java.lang.String> encodeQueryParams(java.lang.String encoding)
                                                                    throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

encodeUriComponent

static java.lang.String encodeUriComponent(java.lang.String source,
                                           java.lang.String encoding,
                                           HierarchicalUriComponents.Type type)
                                    throws java.io.UnsupportedEncodingException

Encode the given source into an encoded String using the rules specified by the given component and with the given options.

Parameters:

source - the source string

encoding - the encoding of the source string

type - the URI component for the source

Returns:

the encoded URI

Throws:

java.lang.IllegalArgumentException - when the given uri parameter is not a valid URI

java.io.UnsupportedEncodingException

encodeBytes

private static byte[] encodeBytes(byte[] source,
                                  HierarchicalUriComponents.Type type)

getHostType

private HierarchicalUriComponents.Type getHostType()

verify

private void verify()

Verifies all URI components to determine whether they contain any illegal characters, throwing an IllegalArgumentException if so.

Throws:

java.lang.IllegalArgumentException - if any component has illegal characters

verifyUriComponent

private static void verifyUriComponent(java.lang.String source,
                                       HierarchicalUriComponents.Type type)

expandInternal

protected HierarchicalUriComponents expandInternal(UriComponents.UriTemplateVariables uriVariables)

Description copied from class: UriComponents

Replace all URI template variables with the values from the given UriComponents.UriTemplateVariables

Specified by:

expandInternal in class UriComponents

Parameters:

uriVariables - URI template values

Returns:

the expanded uri components

expandQueryParams

private MultiValueMap<java.lang.String,java.lang.String> expandQueryParams(UriComponents.UriTemplateVariables variables)

normalize

public UriComponents normalize()

Normalize the path removing sequences like "path/..".

Specified by:

normalize in class UriComponents

See Also:

StringUtils.cleanPath(String)

toUriString

public java.lang.String toUriString()

Returns a URI string from this UriComponents instance.

Specified by:

toUriString in class UriComponents

toUri

public java.net.URI toUri()

Returns a URI from this UriComponents instance.

Specified by:

toUri in class UriComponents

copyToUriComponentsBuilder

protected void copyToUriComponentsBuilder(UriComponentsBuilder builder)

Description copied from class: UriComponents

Set all components of the given UriComponentsBuilder.

Specified by:

copyToUriComponentsBuilder in class UriComponents

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object