Grizzly NIO 5.0.2 · org.glassfish.grizzly.http.util.HttpRequestURIDecoder

Modifier and Type	Field and Description
protected static final boolean	ALLOW_BACKSLASH
private static final boolean	COLLAPSE_ADJACENT_SLASHES
private static final Logger	LOGGER
private static final int	STATE_CHAR
private static final int	STATE_PERCENT
private static final int	STATE_SLASH
private static final int	STATE_SLASHDOT
private static final int	STATE_SLASHDOTDOT

Access	Constructor and Description
public	HttpRequestURIDecoder()

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: `true` if the uriCC represents a normalized URI, or `false` otherwise checkNormalize(final CharChunk URI to be checked (should be chars) uriCC) Check that the URI is normalized following character decoding.
protected void	convertMB(MessageBytes mb) Character conversion of the a US-ASCII MessageBytes.
public static void	convertToChars(final DataChunk - The bytes to decode decodedURI, Charset the encoding value, default is UTF-8. encoding) Converts the normalized the HTTP request represented by the bytes inside `DataChunk` to chars representation, using the passed encoding.
private static void	convertURI(final MessageBytes - The bytes to decode uri, final String the encoding value encoding, B2CConverter the Bytes to Char Converter. b2cConverter) Convert a URI using the specified encoding, using the specified [@link B2CConverter} to decode the request.
protected static void	copyBytes(byte[] b, int dest, int src, int len) Copy an array of bytes to a different position.
private static void	copyChars(char[] c, int dest, int src, int len) Copy an array of chars to a different position.
public static void	decode(final MessageBytes - The bytes to decode decodedURI, final UDecoder - The urlDecoder to use to decode. urlDecoder) Decode the http request represented by the bytes inside `MessageBytes` using an `UDecoder`.
public static void	decode(final MessageBytes - The bytes to decode decodedURI, final UDecoder - The urlDecoder to use to decode. urlDecoder, String the encoding value, default is UTF-8. encoding, final B2CConverter the Bytes to Char Converter. b2cConverter) Decode the HTTP request represented by the bytes inside `MessageBytes` using an `UDecoder`, using the specified encoding, using the specified [@link B2CConverter} to decode the request.
public static void	decode(final DataChunk - The bytes to decode decodedURI) Decode the HTTP request represented by the bytes inside `DataChunk`.
public static void	decode(final DataChunk - The bytes to decode decodedURI, final boolean allow encoded slashes isSlashAllowed) Decode the HTTP request represented by the bytes inside `DataChunk`.
public static void	decode(final DataChunk - The bytes to decode decodedURI, final boolean allow encoded slashes isSlashAllowed, final Charset the encoding value, default is UTF-8. encoding) Decode the HTTP request represented by the bytes inside `DataChunk`.
public static void	decode(final DataChunk - The bytes to decode originalURI, final DataChunk the target `DataChunk` URI will be decoded to targetDecodedURI, final boolean is '/' an allowable character isSlashAllowed, final Charset the encoding value, default is UTF-8 encoding) Decode the HTTP request represented by the bytes inside `DataChunk`.
protected void	log(String Message to be logged message) Log a message on the Logger associated with our Container (if any)
protected void	log(String Message to be logged message, Throwable Associated exception throwable) Log a message on the Logger associated with our Container (if any)
public static boolean	Returns: `true` if normalization was successful, or `false` otherwise normalize(MessageBytes URI to be normalized uriMB) Normalize URI.
public static boolean	Returns: `true` if normalization was successful, or `false` otherwise normalize(final DataChunk URI to be normalized dataChunk) Normalize URI.
public static boolean	normalizeBuffer(final BufferChunk bc)
public static boolean	normalizeBytes(final ByteChunk bc)
public static boolean	normalizeChars(final CharChunk uriCC)

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

ALLOW_BACKSLASH	back to summary
protected static final boolean ALLOW_BACKSLASH

COLLAPSE_ADJACENT_SLASHES	back to summary
private static final boolean COLLAPSE_ADJACENT_SLASHES

LOGGER	back to summary
private static final Logger LOGGER

STATE_CHAR	back to summary
private static final int STATE_CHAR

STATE_PERCENT	back to summary
private static final int STATE_PERCENT

STATE_SLASH	back to summary
private static final int STATE_SLASH

STATE_SLASHDOT	back to summary
private static final int STATE_SLASHDOT

STATE_SLASHDOTDOT	back to summary
private static final int STATE_SLASHDOTDOT

HttpRequestURIDecoder	back to summary
public HttpRequestURIDecoder()

Method Detail

checkNormalize back to summary

checkNormalize	back to summary
public static boolean checkNormalize(final CharChunk uriCC) Check that the URI is normalized following character decoding. This method checks for "\", 0, "//", "/./" and "/../". This method will return false if sequences that are supposed to be normalized are still present in the URI. Parameters uriCC:CharChunk URI to be checked (should be chars) Returns:boolean `true` if the uriCC represents a normalized URI, or `false` otherwise

public static boolean checkNormalize(final CharChunk uriCC)

Check that the URI is normalized following character decoding.

This method checks for "\", 0, "//", "/./" and "/../". This method will return false if sequences that are supposed to be normalized are still present in the URI.

Parameters

uriCC:CharChunk: URI to be checked (should be chars)

Returns:boolean

true if the uriCC represents a normalized URI, or false otherwise

convertMB	back to summary
protected void convertMB(MessageBytes mb) Character conversion of the a US-ASCII MessageBytes.

convertToChars back to summary

convertToChars	back to summary
public static void convertToChars(final DataChunk decodedURI, Charset encoding) throws CharConversionException Converts the normalized the HTTP request represented by the bytes inside `DataChunk` to chars representation, using the passed encoding. Parameters decodedURI:DataChunk - The bytes to decode encoding:Charset the encoding value, default is UTF-8.

public static void convertToChars(final DataChunk decodedURI, Charset encoding) throws CharConversionException

Converts the normalized the HTTP request represented by the bytes inside DataChunk to chars representation, using the passed encoding.

Parameters

decodedURI:DataChunk: - The bytes to decode
encoding:Charset: the encoding value, default is UTF-8.

convertURI	back to summary
private static void convertURI(final MessageBytes uri, final String encoding, B2CConverter b2cConverter) throws Exception Convert a URI using the specified encoding, using the specified [@link B2CConverter} to decode the request. Parameters uri:MessageBytes - The bytes to decode encoding:String the encoding value b2cConverter:B2CConverter the Bytes to Char Converter.

convertURI

back to summary

private static void convertURI(final MessageBytes uri, final String encoding, B2CConverter b2cConverter) throws Exception

Convert a URI using the specified encoding, using the specified [@link B2CConverter} to decode the request.

Parameters

uri:MessageBytes: - The bytes to decode
encoding:String: the encoding value
b2cConverter:B2CConverter: the Bytes to Char Converter.

copyBytes	back to summary
protected static void copyBytes(byte[] b, int dest, int src, int len) Copy an array of bytes to a different position. Used during normalization.

copyChars	back to summary
private static void copyChars(char[] c, int dest, int src, int len) Copy an array of chars to a different position. Used during normalization.

decode back to summary

decode	back to summary
public static void decode(final MessageBytes decodedURI, final UDecoder urlDecoder) throws Exception Decode the http request represented by the bytes inside `MessageBytes` using an `UDecoder`. Parameters decodedURI:MessageBytes - The bytes to decode urlDecoder:UDecoder - The urlDecoder to use to decode.

public static void decode(final MessageBytes decodedURI, final UDecoder urlDecoder) throws Exception

Decode the http request represented by the bytes inside MessageBytes using an UDecoder.

Parameters

decodedURI:MessageBytes: - The bytes to decode
urlDecoder:UDecoder: - The urlDecoder to use to decode.

decode back to summary

decode	back to summary
public static void decode(final MessageBytes decodedURI, final UDecoder urlDecoder, String encoding, final B2CConverter b2cConverter) throws Exception Decode the HTTP request represented by the bytes inside `MessageBytes` using an `UDecoder`, using the specified encoding, using the specified [@link B2CConverter} to decode the request. Parameters decodedURI:MessageBytes - The bytes to decode urlDecoder:UDecoder - The urlDecoder to use to decode. encoding:String the encoding value, default is UTF-8. b2cConverter:B2CConverter the Bytes to Char Converter.

public static void decode(final MessageBytes decodedURI, final UDecoder urlDecoder, String encoding, final B2CConverter b2cConverter) throws Exception

Decode the HTTP request represented by the bytes inside MessageBytes using an UDecoder, using the specified encoding, using the specified [@link B2CConverter} to decode the request.

Parameters

decodedURI:MessageBytes: - The bytes to decode
urlDecoder:UDecoder: - The urlDecoder to use to decode.
encoding:String: the encoding value, default is UTF-8.
b2cConverter:B2CConverter: the Bytes to Char Converter.

decode back to summary

decode	back to summary
public static void decode(final DataChunk decodedURI) throws CharConversionException Decode the HTTP request represented by the bytes inside `DataChunk`. Parameters decodedURI:DataChunk - The bytes to decode

public static void decode(final DataChunk decodedURI) throws CharConversionException

Decode the HTTP request represented by the bytes inside DataChunk.

Parameters

decodedURI:DataChunk: - The bytes to decode

decode back to summary

decode	back to summary
public static void decode(final DataChunk decodedURI, final boolean isSlashAllowed) throws CharConversionException Decode the HTTP request represented by the bytes inside `DataChunk`. Parameters decodedURI:DataChunk - The bytes to decode isSlashAllowed:boolean allow encoded slashes

public static void decode(final DataChunk decodedURI, final boolean isSlashAllowed) throws CharConversionException

Decode the HTTP request represented by the bytes inside DataChunk.

Parameters

decodedURI:DataChunk: - The bytes to decode
isSlashAllowed:boolean: allow encoded slashes

decode back to summary

decode	back to summary
public static void decode(final DataChunk decodedURI, final boolean isSlashAllowed, final Charset encoding) throws CharConversionException Decode the HTTP request represented by the bytes inside `DataChunk`. Parameters decodedURI:DataChunk - The bytes to decode isSlashAllowed:boolean allow encoded slashes encoding:Charset the encoding value, default is UTF-8.

public static void decode(final DataChunk decodedURI, final boolean isSlashAllowed, final Charset encoding) throws CharConversionException

Decode the HTTP request represented by the bytes inside DataChunk.

Parameters

decodedURI:DataChunk: - The bytes to decode
isSlashAllowed:boolean: allow encoded slashes
encoding:Charset: the encoding value, default is UTF-8.

decode back to summary

decode	back to summary
public static void decode(final DataChunk originalURI, final DataChunk targetDecodedURI, final boolean isSlashAllowed, final Charset encoding) throws CharConversionException Decode the HTTP request represented by the bytes inside `DataChunk`. Parameters originalURI:DataChunk - The bytes to decode targetDecodedURI:DataChunk the target `DataChunk` URI will be decoded to isSlashAllowed:boolean is '/' an allowable character encoding:Charset the encoding value, default is UTF-8

public static void decode(final DataChunk originalURI, final DataChunk targetDecodedURI, final boolean isSlashAllowed, final Charset encoding) throws CharConversionException

Decode the HTTP request represented by the bytes inside DataChunk.

Parameters

originalURI:DataChunk: - The bytes to decode
targetDecodedURI:DataChunk: the target DataChunk URI will be decoded to
isSlashAllowed:boolean: is '/' an allowable character
encoding:Charset: the encoding value, default is UTF-8

log	back to summary
protected void log(String message) Log a message on the Logger associated with our Container (if any) Parameters message:String Message to be logged

log

back to summary

protected void log(String message)

Log a message on the Logger associated with our Container (if any)

Parameters

message:String: Message to be logged

log	back to summary
protected void log(String message, Throwable throwable) Log a message on the Logger associated with our Container (if any) Parameters message:String Message to be logged throwable:Throwable Associated exception

log

back to summary

protected void log(String message, Throwable throwable)

Log a message on the Logger associated with our Container (if any)

Parameters

message:String: Message to be logged
throwable:Throwable: Associated exception

normalize back to summary

normalize	back to summary
public static boolean normalize(MessageBytes uriMB) Normalize URI. This method normalizes "\", "//", "/./" and "/../". This method will return false when trying to go above the root, or if the URI contains a null byte. Parameters uriMB:MessageBytes URI to be normalized Returns:boolean `true` if normalization was successful, or `false` otherwise

public static boolean normalize(MessageBytes uriMB)

Normalize URI.

This method normalizes "\", "//", "/./" and "/../". This method will return false when trying to go above the root, or if the URI contains a null byte.

Parameters

uriMB:MessageBytes: URI to be normalized

Returns:boolean

true if normalization was successful, or false otherwise

normalize back to summary

normalize	back to summary
public static boolean normalize(final DataChunk dataChunk) Normalize URI. This method normalizes "\", "//", "/./" and "/../". This method will return false when trying to go above the root, or if the URI contains a null byte. Parameters dataChunk:DataChunk URI to be normalized Returns:boolean `true` if normalization was successful, or `false` otherwise

public static boolean normalize(final DataChunk dataChunk)

Normalize URI.

This method normalizes "\", "//", "/./" and "/../". This method will return false when trying to go above the root, or if the URI contains a null byte.

Parameters

dataChunk:DataChunk: URI to be normalized

Returns:boolean

true if normalization was successful, or false otherwise

normalizeBuffer	back to summary
public static boolean normalizeBuffer(final BufferChunk bc)

normalizeBytes	back to summary
public static boolean normalizeBytes(final ByteChunk bc)

normalizeChars	back to summary
public static boolean normalizeChars(final CharChunk uriCC)

public Class HttpRequestURIDecoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail