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 "%xy" format.

Since:

3.0

Author:

Arjen Poutsma, Juergen Hoeller

See Also:

RFC 3986

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.nio.charset.Charset charset) Decode the given encoded URI component.
static java.lang.String	decode(java.lang.String source, java.lang.String encoding) Decode the given encoded URI component.
static java.lang.String	encode(java.lang.String source, java.nio.charset.Charset charset) Encode characters outside the unreserved character set as defined in RFC 3986 Section 2.
static java.lang.String	encode(java.lang.String source, java.lang.String encoding) Encode characters outside the unreserved character set as defined in RFC 3986 Section 2.
static java.lang.String	encodeAuthority(java.lang.String authority, java.nio.charset.Charset charset) Encode the given URI authority with the given encoding.
static java.lang.String	encodeAuthority(java.lang.String authority, java.lang.String encoding) Encode the given URI authority with the given encoding.
static java.lang.String	encodeFragment(java.lang.String fragment, java.nio.charset.Charset charset) Encode the given URI fragment with the given encoding.
static java.lang.String	encodeFragment(java.lang.String fragment, java.lang.String encoding) Encode the given URI fragment with the given encoding.
static java.lang.String	encodeHost(java.lang.String host, java.nio.charset.Charset charset) Encode the given URI host with the given encoding.
static java.lang.String	encodeHost(java.lang.String host, java.lang.String encoding) Encode the given URI host with the given encoding.
static java.lang.String	encodePath(java.lang.String path, java.nio.charset.Charset charset) Encode the given URI path with the given encoding.
static java.lang.String	encodePath(java.lang.String path, java.lang.String encoding) Encode the given URI path with the given encoding.
static java.lang.String	encodePathSegment(java.lang.String segment, java.nio.charset.Charset charset) Encode the given URI path segment with the given encoding.
static java.lang.String	encodePathSegment(java.lang.String segment, java.lang.String encoding) Encode the given URI path segment with the given encoding.
static java.lang.String	encodePort(java.lang.String port, java.nio.charset.Charset charset) Encode the given URI port with the given encoding.
static java.lang.String	encodePort(java.lang.String port, java.lang.String encoding) Encode the given URI port with the given encoding.
static java.lang.String	encodeQuery(java.lang.String query, java.nio.charset.Charset charset) Encode the given URI query with the given encoding.
static java.lang.String	encodeQuery(java.lang.String query, java.lang.String encoding) Encode the given URI query with the given encoding.
static java.lang.String	encodeQueryParam(java.lang.String queryParam, java.nio.charset.Charset charset) Encode the given URI query parameter with the given encoding.
static java.lang.String	encodeQueryParam(java.lang.String queryParam, java.lang.String encoding) Encode the given URI query parameter with the given encoding.
static java.lang.String	encodeScheme(java.lang.String scheme, java.nio.charset.Charset charset) Encode the given URI scheme with the given encoding.
static java.lang.String	encodeScheme(java.lang.String scheme, java.lang.String encoding) Encode the given URI scheme with the given encoding.
static java.util.Map<java.lang.String,java.lang.String>	encodeUriVariables(java.util.Map<java.lang.String,?> uriVariables) Apply encode(String, String) to the values in the given URI variables and return a new Map containing the encoded values.
static java.lang.Object[]	encodeUriVariables(java.lang.Object... uriVariables) Apply encode(String, String) to the values in the given URI variables and return a new array containing the encoded values.
static java.lang.String	encodeUserInfo(java.lang.String userInfo, java.nio.charset.Charset charset) Encode the given URI user info with the given encoding.
static java.lang.String	encodeUserInfo(java.lang.String userInfo, java.lang.String encoding) Encode the given URI user info with the given encoding.
static java.lang.String	extractFileExtension(java.lang.String path) Extract the file extension from the given URI path.

Methods inherited from class java.lang.Object

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

Constructor Detail

UriUtils

public UriUtils()

Method Detail

encodeScheme

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

Encode 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

encodeScheme

public static java.lang.String encodeScheme(java.lang.String scheme,
                                            java.nio.charset.Charset charset)

Encode the given URI scheme with the given encoding.

Parameters:

scheme - the scheme to be encoded

charset - the character encoding to encode to

Returns:

the encoded scheme

Since:

5.0

encodeAuthority

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

Encode 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

encodeAuthority

public static java.lang.String encodeAuthority(java.lang.String authority,
                                               java.nio.charset.Charset charset)

Encode the given URI authority with the given encoding.

Parameters:

authority - the authority to be encoded

charset - the character encoding to encode to

Returns:

the encoded authority

Since:

5.0

encodeUserInfo

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

Encode 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

encodeUserInfo

public static java.lang.String encodeUserInfo(java.lang.String userInfo,
                                              java.nio.charset.Charset charset)

Encode the given URI user info with the given encoding.

Parameters:

userInfo - the user info to be encoded

charset - the character encoding to encode to

Returns:

the encoded user info

Since:

5.0

encodeHost

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

Encode 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

encodeHost

public static java.lang.String encodeHost(java.lang.String host,
                                          java.nio.charset.Charset charset)

Encode the given URI host with the given encoding.

Parameters:

host - the host to be encoded

charset - the character encoding to encode to

Returns:

the encoded host

Since:

5.0

encodePort

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

Encode 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

encodePort

public static java.lang.String encodePort(java.lang.String port,
                                          java.nio.charset.Charset charset)

Encode the given URI port with the given encoding.

Parameters:

port - the port to be encoded

charset - the character encoding to encode to

Returns:

the encoded port

Since:

5.0

encodePath

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

Encode 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

encodePath

public static java.lang.String encodePath(java.lang.String path,
                                          java.nio.charset.Charset charset)

Encode the given URI path with the given encoding.

Parameters:

path - the path to be encoded

charset - the character encoding to encode to

Returns:

the encoded path

Since:

5.0

encodePathSegment

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

Encode 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

encodePathSegment

public static java.lang.String encodePathSegment(java.lang.String segment,
                                                 java.nio.charset.Charset charset)

Encode the given URI path segment with the given encoding.

Parameters:

segment - the segment to be encoded

charset - the character encoding to encode to

Returns:

the encoded segment

Since:

5.0

encodeQuery

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

Encode 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

encodeQuery

public static java.lang.String encodeQuery(java.lang.String query,
                                           java.nio.charset.Charset charset)

Encode the given URI query with the given encoding.

Parameters:

query - the query to be encoded

charset - the character encoding to encode to

Returns:

the encoded query

Since:

5.0

encodeQueryParam

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

Encode 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

encodeQueryParam

public static java.lang.String encodeQueryParam(java.lang.String queryParam,
                                                java.nio.charset.Charset charset)

Encode the given URI query parameter with the given encoding.

Parameters:

queryParam - the query parameter to be encoded

charset - the character encoding to encode to

Returns:

the encoded query parameter

Since:

5.0

encodeFragment

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

Encode 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

encodeFragment

public static java.lang.String encodeFragment(java.lang.String fragment,
                                              java.nio.charset.Charset charset)

Encode the given URI fragment with the given encoding.

Parameters:

fragment - the fragment to be encoded

charset - the character encoding to encode to

Returns:

the encoded fragment

Since:

5.0

encode

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

Encode characters outside the unreserved character set as defined in RFC 3986 Section 2.

This can be used to ensure the given String will not contain any characters with reserved URI meaning regardless of URI component.

Parameters:

source - the String to be encoded

encoding - the character encoding to encode to

Returns:

the encoded String

Throws:

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

encode

public static java.lang.String encode(java.lang.String source,
                                      java.nio.charset.Charset charset)

Encode characters outside the unreserved character set as defined in RFC 3986 Section 2.

This can be used to ensure the given String will not contain any characters with reserved URI meaning regardless of URI component.

Parameters:

source - the String to be encoded

charset - the character encoding to encode to

Returns:

the encoded String

Since:

5.0

decode

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

Decode the given encoded URI component.

See StringUtils.uriDecode(String, Charset) for the decoding rules.

Parameters:

source - the encoded String

encoding - the character encoding to use

Returns:

the decoded value

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:

StringUtils.uriDecode(String, Charset), URLDecoder.decode(String, String)

decode

public static java.lang.String decode(java.lang.String source,
                                      java.nio.charset.Charset charset)

Decode the given encoded URI component.

See StringUtils.uriDecode(String, Charset) for the decoding rules.

Parameters:

source - the encoded String

charset - the character encoding to use

Returns:

the decoded value

Throws:

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

Since:

5.0

See Also:

StringUtils.uriDecode(String, Charset), URLDecoder.decode(String, String)

extractFileExtension

@Nullable
public static java.lang.String extractFileExtension(java.lang.String path)

Extract the file extension from the given URI path.

Parameters:

path - the URI path (e.g. "/products/index.html")

Returns:

the extracted file extension (e.g. "html")

Since:

4.3.2

encodeUriVariables

public static java.util.Map<java.lang.String,java.lang.String> encodeUriVariables(java.util.Map<java.lang.String,?> uriVariables)

Apply encode(String, String) to the values in the given URI variables and return a new Map containing the encoded values.

Parameters:

uriVariables - the URI variable values to be encoded

Returns:

the encoded String

Since:

5.0

encodeUriVariables

public static java.lang.Object[] encodeUriVariables(java.lang.Object... uriVariables)

Apply encode(String, String) to the values in the given URI variables and return a new array containing the encoded values.

Parameters:

uriVariables - the URI variable values to be encoded

Returns:

the encoded String

Since:

5.0