org.springframework.web.util

Class UriUtils

java.lang.Object

org.springframework.web.util.UriUtils

public abstract class UriUtils
extends java.lang.Object

Utility class for URI encoding and decoding based on RFC 3986. Offers encoding methods for the various URI components.

All encode*(String, String methods in this class operate in a similar way:

• Valid characters for the specific URI component as defined in RFC 3986 stay the same.
• All other characters are converted into one or more bytes in the given encoding scheme. Each of the resulting bytes is written as a hexadecimal string in the "%<i>xy</i>" format.

Since:

3.0

Author:

Arjen Poutsma

See Also:

RFC 3986

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	HOST_PATTERN
private static java.lang.String	HTTP_PATTERN
private static java.util.regex.Pattern	HTTP_URL_PATTERN
private static java.lang.String	LAST_PATTERN
private static java.lang.String	PATH_PATTERN
private static java.lang.String	PORT_PATTERN
private static java.lang.String	QUERY_PATTERN
private static java.lang.String	SCHEME_PATTERN
private static java.util.regex.Pattern	URI_PATTERN
private static java.lang.String	USERINFO_PATTERN

Constructor Summary

Constructors

Constructor and Description
UriUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	decode(java.lang.String source, java.lang.String encoding) Decodes the given encoded source String into an URI.
static java.lang.String	encodeAuthority(java.lang.String authority, java.lang.String encoding) Encodes the given URI authority with the given encoding.
static java.lang.String	encodeFragment(java.lang.String fragment, java.lang.String encoding) Encodes the given URI fragment with the given encoding.
static java.lang.String	encodeHost(java.lang.String host, java.lang.String encoding) Encodes the given URI host with the given encoding.
static java.lang.String	encodeHttpUrl(java.lang.String httpUrl, java.lang.String encoding) Deprecated. in favor of UriComponentsBuilder; see note about query param encoding
static java.lang.String	encodePath(java.lang.String path, java.lang.String encoding) Encodes the given URI path with the given encoding.
static java.lang.String	encodePathSegment(java.lang.String segment, java.lang.String encoding) Encodes the given URI path segment with the given encoding.
static java.lang.String	encodePort(java.lang.String port, java.lang.String encoding) Encodes the given URI port with the given encoding.
static java.lang.String	encodeQuery(java.lang.String query, java.lang.String encoding) Encodes the given URI query with the given encoding.
static java.lang.String	encodeQueryParam(java.lang.String queryParam, java.lang.String encoding) Encodes the given URI query parameter with the given encoding.
static java.lang.String	encodeScheme(java.lang.String scheme, java.lang.String encoding) Encodes the given URI scheme with the given encoding.
static java.lang.String	encodeUri(java.lang.String uri, java.lang.String encoding) Deprecated. in favor of UriComponentsBuilder; see note about query param encoding
static java.lang.String	encodeUriComponents(java.lang.String scheme, java.lang.String authority, java.lang.String userInfo, java.lang.String host, java.lang.String port, java.lang.String path, java.lang.String query, java.lang.String fragment, java.lang.String encoding) Deprecated. in favor of UriComponentsBuilder
static java.lang.String	encodeUserInfo(java.lang.String userInfo, java.lang.String encoding) Encodes the given URI user info with the given encoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCHEME_PATTERN

private static final java.lang.String SCHEME_PATTERN

See Also:

Constant Field Values

HTTP_PATTERN

private static final java.lang.String HTTP_PATTERN

See Also:

Constant Field Values

USERINFO_PATTERN

private static final java.lang.String USERINFO_PATTERN

See Also:

Constant Field Values

HOST_PATTERN

private static final java.lang.String HOST_PATTERN

See Also:

Constant Field Values

PORT_PATTERN

private static final java.lang.String PORT_PATTERN

See Also:

Constant Field Values

PATH_PATTERN

private static final java.lang.String PATH_PATTERN

See Also:

Constant Field Values

QUERY_PATTERN

private static final java.lang.String QUERY_PATTERN

See Also:

Constant Field Values

LAST_PATTERN

private static final java.lang.String LAST_PATTERN

See Also:

Constant Field Values

URI_PATTERN

private static final java.util.regex.Pattern URI_PATTERN

HTTP_URL_PATTERN

private static final java.util.regex.Pattern HTTP_URL_PATTERN

Constructor Detail

UriUtils

public UriUtils()

Method Detail

encodeUri

@Deprecated
public static java.lang.String encodeUri(java.lang.String uri,
                                    java.lang.String encoding)
                                  throws java.io.UnsupportedEncodingException

Deprecated. in favor of UriComponentsBuilder; see note about query param encoding

Encodes the given source URI into an encoded String. All various URI components are encoded according to their respective valid character sets.

Note that this method does not attempt to encode "=" and "&" characters in query parameter names and query parameter values because they cannot be parsed in a reliable way. Instead use:

 UriComponents uriComponents = UriComponentsBuilder.fromUri("/path?name={value}").buildAndExpand("a=b");
 String encodedUri = uriComponents.encode().toUriString();
 

Parameters:

uri - the URI to be encoded

encoding - the character encoding to encode to

Returns:

the encoded URI

Throws:

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

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeHttpUrl

@Deprecated
public static java.lang.String encodeHttpUrl(java.lang.String httpUrl,
                                        java.lang.String encoding)
                                      throws java.io.UnsupportedEncodingException

Deprecated. in favor of UriComponentsBuilder; see note about query param encoding

Encodes the given HTTP URI into an encoded String. All various URI components are encoded according to their respective valid character sets.

Note that this method does not support fragments (#), as these are not supposed to be sent to the server, but retained by the client.

Note that this method does not attempt to encode "=" and "&" characters in query parameter names and query parameter values because they cannot be parsed in a reliable way. Instead use:

 UriComponents uriComponents = UriComponentsBuilder.fromHttpUrl("/path?name={value}").buildAndExpand("a=b");
 String encodedUri = uriComponents.encode().toUriString();
 

Parameters:

httpUrl - the HTTP URL to be encoded

encoding - the character encoding to encode to

Returns:

the encoded URL

Throws:

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

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeUriComponents

@Deprecated
public static java.lang.String encodeUriComponents(java.lang.String scheme,
                                              java.lang.String authority,
                                              java.lang.String userInfo,
                                              java.lang.String host,
                                              java.lang.String port,
                                              java.lang.String path,
                                              java.lang.String query,
                                              java.lang.String fragment,
                                              java.lang.String encoding)
                                            throws java.io.UnsupportedEncodingException

Deprecated. in favor of UriComponentsBuilder

Encodes the given source URI components into an encoded String. All various URI components are optional, but encoded according to their respective valid character sets.

Parameters:

scheme - the scheme

authority - the authority

userInfo - the user info

host - the host

port - the port

path - the path

query - the query

fragment - the fragment

encoding - the character encoding to encode to

Returns:

the encoded URI

Throws:

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

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeScheme

public static java.lang.String encodeScheme(java.lang.String scheme,
                            java.lang.String encoding)
                                     throws java.io.UnsupportedEncodingException

Encodes the given URI scheme with the given encoding.

Parameters:

scheme - the scheme to be encoded

encoding - the character encoding to encode to

Returns:

the encoded scheme

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeAuthority

public static java.lang.String encodeAuthority(java.lang.String authority,
                               java.lang.String encoding)
                                        throws java.io.UnsupportedEncodingException

Encodes the given URI authority with the given encoding.

Parameters:

authority - the authority to be encoded

encoding - the character encoding to encode to

Returns:

the encoded authority

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeUserInfo

public static java.lang.String encodeUserInfo(java.lang.String userInfo,
                              java.lang.String encoding)
                                       throws java.io.UnsupportedEncodingException

Encodes the given URI user info with the given encoding.

Parameters:

userInfo - the user info to be encoded

encoding - the character encoding to encode to

Returns:

the encoded user info

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeHost

public static java.lang.String encodeHost(java.lang.String host,
                          java.lang.String encoding)
                                   throws java.io.UnsupportedEncodingException

Encodes the given URI host with the given encoding.

Parameters:

host - the host to be encoded

encoding - the character encoding to encode to

Returns:

the encoded host

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodePort

public static java.lang.String encodePort(java.lang.String port,
                          java.lang.String encoding)
                                   throws java.io.UnsupportedEncodingException

Encodes the given URI port with the given encoding.

Parameters:

port - the port to be encoded

encoding - the character encoding to encode to

Returns:

the encoded port

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodePath

public static java.lang.String encodePath(java.lang.String path,
                          java.lang.String encoding)
                                   throws java.io.UnsupportedEncodingException

Encodes the given URI path with the given encoding.

Parameters:

path - the path to be encoded

encoding - the character encoding to encode to

Returns:

the encoded path

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodePathSegment

public static java.lang.String encodePathSegment(java.lang.String segment,
                                 java.lang.String encoding)
                                          throws java.io.UnsupportedEncodingException

Encodes the given URI path segment with the given encoding.

Parameters:

segment - the segment to be encoded

encoding - the character encoding to encode to

Returns:

the encoded segment

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeQuery

public static java.lang.String encodeQuery(java.lang.String query,
                           java.lang.String encoding)
                                    throws java.io.UnsupportedEncodingException

Encodes the given URI query with the given encoding.

Parameters:

query - the query to be encoded

encoding - the character encoding to encode to

Returns:

the encoded query

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeQueryParam

public static java.lang.String encodeQueryParam(java.lang.String queryParam,
                                java.lang.String encoding)
                                         throws java.io.UnsupportedEncodingException

Encodes the given URI query parameter with the given encoding.

Parameters:

queryParam - the query parameter to be encoded

encoding - the character encoding to encode to

Returns:

the encoded query parameter

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

encodeFragment

public static java.lang.String encodeFragment(java.lang.String fragment,
                              java.lang.String encoding)
                                       throws java.io.UnsupportedEncodingException

Encodes the given URI fragment with the given encoding.

Parameters:

fragment - the fragment to be encoded

encoding - the character encoding to encode to

Returns:

the encoded fragment

Throws:

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

decode

public static java.lang.String decode(java.lang.String source,
                      java.lang.String encoding)
                               throws java.io.UnsupportedEncodingException

Decodes the given encoded source String into an URI. Based on the following rules:

• Alphanumeric characters "a" through "z", "A" through "Z", and "0" through "9" stay the same.
• Special characters "-", "_", ".", and "*" stay the same.
• A sequence "%<i>xy</i>" is interpreted as a hexadecimal representation of the character.

Parameters:

source - the source string

encoding - the encoding

Returns:

the decoded URI

Throws:

java.lang.IllegalArgumentException - when the given source contains invalid encoded sequences

java.io.UnsupportedEncodingException - when the given encoding parameter is not supported

See Also:

URLDecoder.decode(String, String)