Tomcat 10.1.19 · org.apache.tomcat.util.http.fileupload.util.mime.RFC2231Utility

Field Summary

Modifier and Type	Field and Description
private static final byte[]	HEX_DECODE The Hexadecimal decode value.
private static final char[]	HEX_DIGITS The Hexadecimal values char array.
private static final byte	MASK The Hexadecimal representation of 127.
private static final int	MASK_128 The Hexadecimal representation of 128.

Constructor Summary

Access	Constructor and Description
private	RFC2231Utility() Private constructor so that no instances can be created.

Method Summary

Modifier and Type	Method and Description
public static String	Returns: Decoded text based on charset encoding decodeText(final String - Text to be decoded has a format of `<charset>'<language>'<encoded_value>` and ASCII only encodedText) Decode a string of text obtained from a HTTP header as per RFC 2231 Eg 1.
private static byte[]	Returns: Byte array of characters decoded from ASCII table fromHex(final String - ASCII text input text) Convert `text` to their corresponding Hex value.
private static String	getJavaCharset(final String mimeCharset)
public static boolean	Returns: `true`, if encoded as per RFC 2231, `false` otherwise hasEncodedValue(final String The parameter, which is being checked. paramName) Checks if Asterisk (*) at the end of parameter name to indicate, if it has charset and language information to decode the value.
public static String	Returns: stripped `paramName` of Asterisk (), if RFC2231 encoded stripDelimiter(final String The parameter, which is being inspected. paramName) If `paramName` has Asterisk () at the end, it will be stripped off, else the passed value will be returned.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

HEX_DECODE	back to summary
private static final byte[] HEX_DECODE The Hexadecimal decode value.

HEX_DIGITS	back to summary
private static final char[] HEX_DIGITS The Hexadecimal values char array.

MASK	back to summary
private static final byte MASK The Hexadecimal representation of 127.

MASK_128	back to summary
private static final int MASK_128 The Hexadecimal representation of 128.

Constructor Detail

RFC2231Utility	back to summary
private RFC2231Utility() Private constructor so that no instances can be created. This class contains only static utility methods.

Method Detail

decodeText back to summary

decodeText	back to summary
public static String decodeText(final String encodedText) throws UnsupportedEncodingException Decode a string of text obtained from a HTTP header as per RFC 2231 Eg 1. `us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A` will be decoded to `This is *fun` Eg 2.* `iso-8859-1'en'%A3%20rate` will be decoded to `£ rate` Eg 3. `UTF-8''%c2%a3%20and%20%e2%82%ac%20rates` will be decoded to `£ and € rates` Parameters encodedText:String - Text to be decoded has a format of `<charset>'<language>'<encoded_value>` and ASCII only Returns:String Decoded text based on charset encoding Exceptions UnsupportedEncodingException: The requested character set wasn't found.

public static String decodeText(final String encodedText) throws UnsupportedEncodingException

Decode a string of text obtained from a HTTP header as per RFC 2231

Eg 1. us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A will be decoded to This is ***fun***

Eg 2. iso-8859-1'en'%A3%20rate will be decoded to £ rate

Eg 3. UTF-8''%c2%a3%20and%20%e2%82%ac%20rates will be decoded to £ and € rates

Parameters

encodedText:String: - Text to be decoded has a format of <charset>'<language>'<encoded_value> and ASCII only

Returns:String

Decoded text based on charset encoding

Exceptions

UnsupportedEncodingException:: The requested character set wasn't found.

fromHex back to summary

fromHex	back to summary
private static byte[] fromHex(final String text) Convert `text` to their corresponding Hex value. Parameters text:String - ASCII text input Returns:byte[] Byte array of characters decoded from ASCII table

private static byte[] fromHex(final String text)

Convert text to their corresponding Hex value.

Parameters

text:String: - ASCII text input

Returns:byte[]

Byte array of characters decoded from ASCII table

getJavaCharset	back to summary
private static String getJavaCharset(final String mimeCharset)

hasEncodedValue back to summary

hasEncodedValue	back to summary
public static boolean hasEncodedValue(final String paramName) Checks if Asterisk (*) at the end of parameter name to indicate, if it has charset and language information to decode the value. Parameters paramName:String The parameter, which is being checked. Returns:boolean `true`, if encoded as per RFC 2231, `false` otherwise

public static boolean hasEncodedValue(final String paramName)

Checks if Asterisk (*) at the end of parameter name to indicate, if it has charset and language information to decode the value.

Parameters

paramName:String: The parameter, which is being checked.

Returns:boolean

true, if encoded as per RFC 2231, false otherwise

stripDelimiter back to summary

stripDelimiter	back to summary
public static String stripDelimiter(final String paramName) If `paramName` has Asterisk () at the end, it will be stripped off, else the passed value will be returned. Parameters paramName:String The parameter, which is being inspected. Returns:String stripped `paramName` of Asterisk (), if RFC2231 encoded

public static String stripDelimiter(final String paramName)

If paramName has Asterisk (*) at the end, it will be stripped off, else the passed value will be returned.

Parameters

paramName:String: The parameter, which is being inspected.

Returns:String

stripped paramName of Asterisk (*), if RFC2231 encoded

public final Class RFC2231Utility

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail