com.bentofw.util
Interface ParsedRequestParameters

public interface ParsedRequestParameters

Interface for HTTP request parameters

Author:

Jun Inamori

Field Summary

static int	GET
static int	MULTIPART
static int	POST

Method Summary

boolean	containsKey(java.lang.String key) Returns true if the request parameter for the key is available in this request.
java.lang.String	getContextPath() Returns the context path.
byte[]	getDecodedBytes(java.lang.String key) Return the decoded byte array of the request parameter specified by the name.
byte[][]	getDecodedBytesInArray(java.lang.String key) Return the array of the decoded byte arrays of the request parameter specified by the name.
java.util.List	getDecodedBytesInList(java.lang.String key) Return the List of the decoded byte arrays of the request parameter specified by the name.
java.lang.String	getDecodedString(java.lang.String key) Return the decoded String of the request parameter specified by the name.
java.lang.String	getDecodedString(java.lang.String key, java.lang.String enc) Return the decoded String of the request parameter specified by the name.
java.lang.String[]	getDecodedStringInArray(java.lang.String key) Return the array of decoded Strings of the request parameter specified by the name.
java.lang.String[]	getDecodedStringInArray(java.lang.String key, java.lang.String enc) Return the array of decoded Strings of the request parameter specified by the name.
java.util.List	getDecodedStringInList(java.lang.String key) Return the List of decoded Strings of the request parameter specified by the name.
java.util.List	getDecodedStringInList(java.lang.String key, java.lang.String enc) Return the List of decoded Strings of the request parameter specified by the name.
java.lang.String	getEncodedString(java.lang.String key) Return the URL-encoded String of the request parameter specified by the name.
java.lang.String[]	getEncodedStringInArray(java.lang.String key) Return the array of URL-encoded Strings of the request parameter specified by the name.
java.util.List	getEncodedStringInList(java.lang.String key) Return the List of URL-encoded Strings of the request parameter specified by the name.
java.lang.String	getEncoding() Return the current character encoding of this HTTP request.
java.lang.String	getHostHeader() Returns the host header of the HTTP request.
java.lang.String[]	getKeysInArray() Return the array of the names of the available request parameters.
java.util.List	getKeysInList() Return the List of the names of the available request parameters.
java.lang.String	getLastPathInfo() Returns the last element within the path information.
int	getLengthOfDecodedString(java.lang.String key) Return the length of the decoded String for the specified parameter.
int[]	getLengthOfDecodedStringInArray(java.lang.String key) Return the length of the decoded Strings for the specified parameter in the array.
int	getLengthOfEncodedString(java.lang.String key) Return the length of the encoded String for the specified parameter.
int[]	getLengthOfEncodedStringInArray(java.lang.String key) Return the length of the encoded Strings for the specified parameter in the array.
int	getLengthOfLongestDecodedString(java.lang.String key) Return the length of the longest decoded Strings for the specified parameter.
int	getLengthOfLongestEncodedString(java.lang.String key) Return the length of the longest encoded Strings for the specified parameter.
int	getMethod() Returns the int value indicating the request method, that is GET, POST or MULTIPART.
java.lang.String	getPathInfo() Returns the path information.
java.lang.String	getServletPath() Return the servlet path of the requested URL.
void	setEncoding(java.lang.String enc) Set the character encoding of this HTTP request.

Field Detail

GET

static final int GET

See Also:

Constant Field Values

POST

static final int POST

See Also:

Constant Field Values

MULTIPART

static final int MULTIPART

See Also:

Constant Field Values

Method Detail

getEncoding

java.lang.String getEncoding()

Return the current character encoding of this HTTP request.

Returns:

The current character encoding of this HTTP request.

setEncoding

void setEncoding(java.lang.String enc)

Set the character encoding of this HTTP request.

containsKey

boolean containsKey(java.lang.String key)

Returns true if the request parameter for the key is available in this request.

Parameters:

key - The name of the request parameter.

Returns:

Returns true if the request parameter for the key is available in this request.

getKeysInArray

java.lang.String[] getKeysInArray()

Return the array of the names of the available request parameters.

Returns:

The array of the names of the available request parameters.

getKeysInList

java.util.List getKeysInList()

Return the List of the names of the available request parameters.

Returns:

The List of the names of the available request parameters.

getEncodedString

java.lang.String getEncodedString(java.lang.String key)

Return the URL-encoded String of the request parameter specified by the name.

If there are more than 2 values for the specified request parameters, this method returns the first value.

Parameters:

key - The name of the request parameter.

Returns:

The URL-encoded String of the request parameter specified by the name.

getEncodedStringInArray

java.lang.String[] getEncodedStringInArray(java.lang.String key)

Return the array of URL-encoded Strings of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

Returns:

The array of URL-encoded Strings of the request parameter specified by the name.

getEncodedStringInList

java.util.List getEncodedStringInList(java.lang.String key)

Return the List of URL-encoded Strings of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

Returns:

The List of URL-encoded Strings of the request parameter specified by the name.

getDecodedBytes

byte[] getDecodedBytes(java.lang.String key)
                       throws NestedException

Return the decoded byte array of the request parameter specified by the name.

If there are more than 2 values for the specified request parameters, this method returns the first value.

Parameters:

key - The name of the request parameter.

Returns:

The decoded byte array of the request parameter specified by the name.

Throws:

NestedException

getDecodedBytesInArray

byte[][] getDecodedBytesInArray(java.lang.String key)
                                throws NestedException

Return the array of the decoded byte arrays of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

Returns:

The array of the decoded byte arrays of the request parameter specified by the name.

Throws:

NestedException

getDecodedBytesInList

java.util.List getDecodedBytesInList(java.lang.String key)
                                     throws NestedException

Return the List of the decoded byte arrays of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

Returns:

The List of the decoded byte arrays of the request parameter specified by the name.

Throws:

NestedException

getDecodedString

java.lang.String getDecodedString(java.lang.String key)
                                  throws NestedException

Return the decoded String of the request parameter specified by the name.

If there are more than 2 values for the specified request parameters, this method returns the first value.

Parameters:

key - The name of the request parameter.

Returns:

The decoded String of the request parameter specified by the name.

Throws:

NestedException

getDecodedStringInArray

java.lang.String[] getDecodedStringInArray(java.lang.String key)
                                           throws NestedException

Return the array of decoded Strings of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

Returns:

The array of decoded Strings of the request parameter specified by the name.

Throws:

NestedException

getDecodedStringInList

java.util.List getDecodedStringInList(java.lang.String key)
                                      throws NestedException

Return the List of decoded Strings of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

Returns:

The List of decoded Strings of the request parameter specified by the name.

Throws:

NestedException

getDecodedString

java.lang.String getDecodedString(java.lang.String key,
                                  java.lang.String enc)
                                  throws NestedException

Return the decoded String of the request parameter specified by the name.

If there are more than 2 values for the specified request parameters, this method returns the first value.

Parameters:

key - The name of the request parameter.

enc - The character encoding to be used for decoding.

Returns:

The decoded String of the request parameter specified by the name.

Throws:

NestedException

getDecodedStringInArray

java.lang.String[] getDecodedStringInArray(java.lang.String key,
                                           java.lang.String enc)
                                           throws NestedException

Return the array of decoded Strings of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

enc - The character encoding to be used for decoding.

Returns:

The array of decoded Strings of the request parameter specified by the name.

Throws:

NestedException

getDecodedStringInList

java.util.List getDecodedStringInList(java.lang.String key,
                                      java.lang.String enc)
                                      throws NestedException

Return the List of decoded Strings of the request parameter specified by the name.

Parameters:

key - The name of the request parameter.

enc - The character encoding to be used for decoding.

Returns:

The List of decoded Strings of the request parameter specified by the name.

Throws:

NestedException

getHostHeader

java.lang.String getHostHeader()

Returns the host header of the HTTP request.

Returns:

The host header of the HTTP request.

getServletPath

java.lang.String getServletPath()

Return the servlet path of the requested URL.

This method returns the same value as:

• HttpServletRequest.getServletPath( )

Returns:

The servlet path of the requested URL.

getLastPathInfo

java.lang.String getLastPathInfo()

Returns the last element within the path information. If no path information is available in the request, this method returns the empty String.

Note that the "path information" is the return value of:

• HttpServletRequest.getPathInfo( )

It is the extra path information associated with the requested URL, that does not include:

• the servlet path
• the query String

Returns:

The last element within the path information.

getPathInfo

java.lang.String getPathInfo()

Returns the path information. If no path information is available in the request, this method returns the empty String.

Note that the "path information" is the return value of:

• HttpServletRequest.getPathInfo( )

It is the extra path information associated with the requested URL, that does not include:

• the servlet path
• the query String

Returns:

The path information of the requested URL.

getContextPath

java.lang.String getContextPath()

Returns the context path. In case of the root context, this method returns the empty String.

Returns:

The context path of the requested URL.

getMethod

int getMethod()

Returns the int value indicating the request method, that is GET, POST or MULTIPART.

Returns:

int value indicating GET, POST or MULTIPART.

getLengthOfEncodedString

int getLengthOfEncodedString(java.lang.String key)
                             throws NestedException

Return the length of the encoded String for the specified parameter.

If there are more than 2 values for the specified request parameters, this method returns the lengh of the first value.

Parameters:

key - The name of the request parameter.

Returns:

Return the length of the first encoded String for the specified parameter.

Throws:

NestedException

getLengthOfEncodedStringInArray

int[] getLengthOfEncodedStringInArray(java.lang.String key)
                                      throws NestedException

Return the length of the encoded Strings for the specified parameter in the array.

Parameters:

key - The name of the request parameter.

Returns:

Return the length of the encoded Strings for the specified parameter in the array.

Throws:

NestedException

getLengthOfLongestEncodedString

int getLengthOfLongestEncodedString(java.lang.String key)
                                    throws NestedException

Return the length of the longest encoded Strings for the specified parameter.

Parameters:

key - The name of the request parameter.

Returns:

Return the length of the longest encoded Strings for the specified parameter.

Throws:

NestedException

getLengthOfDecodedString

int getLengthOfDecodedString(java.lang.String key)
                             throws NestedException

Return the length of the decoded String for the specified parameter.

If there are more than 2 values for the specified request parameters, this method returns the lengh of the first value.

Parameters:

key - The name of the request parameter.

Returns:

Return the length of the first decoded String for the specified parameter.

Throws:

NestedException

getLengthOfDecodedStringInArray

int[] getLengthOfDecodedStringInArray(java.lang.String key)
                                      throws NestedException

Return the length of the decoded Strings for the specified parameter in the array.

Parameters:

key - The name of the request parameter.

Returns:

Return the length of the decoded Strings for the specified parameter in the array.

Throws:

NestedException

getLengthOfLongestDecodedString

int getLengthOfLongestDecodedString(java.lang.String key)
                                    throws NestedException

Return the length of the longest decoded Strings for the specified parameter.

Parameters:

key - The name of the request parameter.

Returns:

Return the length of the longest decoded Strings for the specified parameter.

Throws:

NestedException