Class UDecoder
java.lang.Object
org.apache.tomcat.util.buf.UDecoder
All URL decoding happens here. This way we can reuse, review, optimize without adding complexity to the buffers. The
conversion will modify the original buffer.
- Author:
- Costin Manolache
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Unused.voidURLDecode, will modify the source.voidconvert(ByteChunk mb, EncodedSolidusHandling encodedSolidusHandling) Deprecated.Unused.voidconvert(ByteChunk mb, EncodedSolidusHandling encodedSolidusHandling, EncodedSolidusHandling encodedReverseSolidusHandling) URLDecode, will modify the source.voidDeprecated.Unused.voidconvert(MessageBytes mb, boolean query) Deprecated.Unused.static StringDeprecated.Unused.static StringDecode and return the specified URL-encoded String.static StringURLDecode(String str, Charset charset, EncodedSolidusHandling encodedSolidusHandling, EncodedSolidusHandling encodedReverseSolidusHandling) Decode and return the specified URL-encoded String.
-
Field Details
-
ALLOW_ENCODED_SLASH
Deprecated.
-
-
Constructor Details
-
UDecoder
public UDecoder()
-
-
Method Details
-
convert
URLDecode, will modify the source. Assumes source bytes are encoded using a superset of US-ASCII as per RFC 7230. "%5c" will be decoded. "%2f" will be rejected unless the input is a query string.- Parameters:
mb- The URL encoded bytesquery-trueif this is a query string. For a query string '+' will be decoded to ' '- Throws:
IOException- Invalid %xx URL encoding
-
convert
@Deprecated public void convert(ByteChunk mb, EncodedSolidusHandling encodedSolidusHandling) throws IOException Deprecated.Unused. Will be removed in Tomcat 12. Useconvert(ByteChunk, EncodedSolidusHandling, EncodedSolidusHandling)URLDecode, will modify the source. Assumes source bytes are encoded using a superset of US-ASCII as per RFC 7230.- Parameters:
mb- The URL encoded bytesencodedSolidusHandling- How should the %2f sequence handled by the decoder? For query strings this parameter will be ignored and the %2f sequence will be decoded- Throws:
IOException- Invalid %xx URL encoding
-
convert
public void convert(ByteChunk mb, EncodedSolidusHandling encodedSolidusHandling, EncodedSolidusHandling encodedReverseSolidusHandling) throws IOException URLDecode, will modify the source. Assumes source bytes are encoded using a superset of US-ASCII as per RFC 7230.- Parameters:
mb- The URL encoded bytesencodedSolidusHandling- How should the %2f sequence handled by the decoder? For query strings this parameter will be ignored and the %2f sequence will be decodedencodedReverseSolidusHandling- How should the %5c sequence handled by the decoder? For query strings this parameter will be ignored and the %5c sequence will be decoded- Throws:
IOException- Invalid %xx URL encoding
-
convert
Deprecated.Unused. Will be removed in Tomcat 10In-buffer processing - the buffer will be modified.WARNING: This method assumes US-ASCII encoding.
- Parameters:
mb- The URL encoded charsquery-trueif this is a query string- Throws:
IOException- Invalid %xx URL encoding
-
convert
Deprecated.Unused. Will be removed in Tomcat 10URLDecode, will modify the source.WARNING: This method assumes US-ASCII encoding.
- Parameters:
mb- The URL encoded String, bytes or charsquery-trueif this is a query string- Throws:
IOException- Invalid %xx URL encoding
-
convert
Deprecated.Unused. Will be removed in Tomcat 10%xx decoding of a string.WARNING: This method assumes US-ASCII encoding.
FIXME: this is inefficient.
- Parameters:
str- The URL encoded stringquery-trueif this is a query string- Returns:
- the decoded string
-
URLDecode
Deprecated.Unused. This will be removed in Tomcat 10 onwardsDecode and return the specified URL-encoded String. When the byte array is converted to a string, UTF-8 is used. This may be different than some other servers. It is assumed the string is not a query string.- Parameters:
str- The url-encoded string- Returns:
- the decoded string
- Throws:
IllegalArgumentException- if a '%' character is not followed by a valid 2-digit hexadecimal number
-
URLDecode
Decode and return the specified URL-encoded String. It is assumed the string is not a query string.- Parameters:
str- The url-encoded stringcharset- The character encoding to use; if null, UTF-8 is used.- Returns:
- the decoded string
- Throws:
IllegalArgumentException- if a '%' character is not followed by a valid 2-digit hexadecimal number
-
URLDecode
public static String URLDecode(String str, Charset charset, EncodedSolidusHandling encodedSolidusHandling, EncodedSolidusHandling encodedReverseSolidusHandling) Decode and return the specified URL-encoded String. It is assumed the string is not a query string.- Parameters:
str- The url-encoded stringcharset- The character encoding to use; if null, UTF-8 is used.encodedSolidusHandling- The required handling of encoded solidus (%2f - /)encodedReverseSolidusHandling- The required handling of encoded reverse solidus (%5c - \)- Returns:
- the decoded string
- Throws:
IllegalArgumentException- if a '%' character is not followed by a valid 2-digit hexadecimal number
-