Package io.netty.handler.codec.http
Class QueryStringDecoder
java.lang.Object
io.netty.handler.codec.http.QueryStringDecoder
Splits an HTTP query string into a path string and key-value parameter pairs.
This decoder is for one time use only. Create a new instance for each URI:
This decoder can also decode the content of an HTTP POST request whose content type is application/x-www-form-urlencoded:QueryStringDecoder
decoder = newQueryStringDecoder
("/hello?recipient=worldinvalid input: '&x'=1;y=2"); assert decoder.path().equals("/hello"); assert decoder.parameters().get("recipient").get(0).equals("world"); assert decoder.parameters().get("x").get(0).equals("1"); assert decoder.parameters().get("y").get(0).equals("2");
QueryStringDecoder
decoder = newQueryStringDecoder
("recipient=worldinvalid input: '&x'=1;y=2", false); ...
HashDOS vulnerability fix
As a workaround to the HashDOS vulnerability, the decoder limits the maximum number of decoded key-value parameter pairs, up to 1024 by default, and you can configure it when you construct the decoder by passing an additional integer parameter.- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionQueryStringDecoder
(String uri) Creates a new decoder that decodes the specified URI.QueryStringDecoder
(String uri, boolean hasPath) Creates a new decoder that decodes the specified URI encoded in the specified charset.QueryStringDecoder
(String uri, Charset charset) Creates a new decoder that decodes the specified URI encoded in the specified charset.QueryStringDecoder
(String uri, Charset charset, boolean hasPath) Creates a new decoder that decodes the specified URI encoded in the specified charset.QueryStringDecoder
(String uri, Charset charset, boolean hasPath, int maxParams) Creates a new decoder that decodes the specified URI encoded in the specified charset.QueryStringDecoder
(String uri, Charset charset, boolean hasPath, int maxParams, boolean semicolonIsNormalChar) Creates a new decoder that decodes the specified URI encoded in the specified charset.QueryStringDecoder
(URI uri) Creates a new decoder that decodes the specified URI.QueryStringDecoder
(URI uri, Charset charset) Creates a new decoder that decodes the specified URI encoded in the specified charset.QueryStringDecoder
(URI uri, Charset charset, int maxParams) Creates a new decoder that decodes the specified URI encoded in the specified charset.QueryStringDecoder
(URI uri, Charset charset, int maxParams, boolean semicolonIsNormalChar) Creates a new decoder that decodes the specified URI encoded in the specified charset. -
Method Summary
Modifier and TypeMethodDescriptionprivate static boolean
addParam
(String s, int nameStart, int valueStart, int valueEnd, Map<String, List<String>> params, Charset charset) static String
Decodes a bit of a URL encoded by a browser.private static String
decodeComponent
(String s, int from, int toExcluded, Charset charset, boolean isPath) static String
decodeComponent
(String s, Charset charset) Decodes a bit of a URL encoded by a browser.decodeParams
(String s, int from, Charset charset, int paramsLimit, boolean semicolonIsNormalChar) private static int
findPathEndIndex
(String uri) Returns the decoded key-value parameter pairs of the URI.path()
Returns the decoded path string of the URI.private int
rawPath()
Returns the raw path string of the URI.rawQuery()
Returns raw query string of the URI.toString()
uri()
Returns the uri used to initialize thisQueryStringDecoder
.
-
Field Details
-
DEFAULT_MAX_PARAMS
private static final int DEFAULT_MAX_PARAMS- See Also:
-
charset
-
uri
-
maxParams
private final int maxParams -
semicolonIsNormalChar
private final boolean semicolonIsNormalChar -
pathEndIdx
private int pathEndIdx -
path
-
params
-
-
Constructor Details
-
QueryStringDecoder
Creates a new decoder that decodes the specified URI. The decoder will assume that the query string is encoded in UTF-8. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI encoded in the specified charset. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI encoded in the specified charset. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI encoded in the specified charset. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI encoded in the specified charset. -
QueryStringDecoder
public QueryStringDecoder(String uri, Charset charset, boolean hasPath, int maxParams, boolean semicolonIsNormalChar) Creates a new decoder that decodes the specified URI encoded in the specified charset. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI. The decoder will assume that the query string is encoded in UTF-8. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI encoded in the specified charset. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI encoded in the specified charset. -
QueryStringDecoder
Creates a new decoder that decodes the specified URI encoded in the specified charset.
-
-
Method Details
-
toString
-
uri
Returns the uri used to initialize thisQueryStringDecoder
. -
path
Returns the decoded path string of the URI. -
parameters
Returns the decoded key-value parameter pairs of the URI. -
rawPath
Returns the raw path string of the URI. -
rawQuery
Returns raw query string of the URI. -
pathEndIdx
private int pathEndIdx() -
decodeParams
-
addParam
-
decodeComponent
Decodes a bit of a URL encoded by a browser.This is equivalent to calling
decodeComponent(String, Charset)
with the UTF-8 charset (recommended to comply with RFC 3986, Section 2).- Parameters:
s
- The string to decode (can be empty).- Returns:
- The decoded string, or
s
if there's nothing to decode. If the string to decode isnull
, returns an empty string. - Throws:
IllegalArgumentException
- if the string contains a malformed escape sequence.
-
decodeComponent
Decodes a bit of a URL encoded by a browser.The string is expected to be encoded as per RFC 3986, Section 2. This is the encoding used by JavaScript functions
encodeURI
andencodeURIComponent
, but notescape
. For example in this encoding, é (in UnicodeU+00E9
or in UTF-80xC3 0xA9
) is encoded as%C3%A9
or%c3%a9
.This is essentially equivalent to calling
URLDecoder.decode(String, String)
except that it's over 2x faster and generates less garbage for the GC. Actually this function doesn't allocate any memory if there's nothing to decode, the argument itself is returned.- Parameters:
s
- The string to decode (can be empty).charset
- The charset to use to decode the string (should really beCharsetUtil.UTF_8
.- Returns:
- The decoded string, or
s
if there's nothing to decode. If the string to decode isnull
, returns an empty string. - Throws:
IllegalArgumentException
- if the string contains a malformed escape sequence.
-
decodeComponent
-
findPathEndIndex
-