freenet.support.api

Interface HTTPRequest

All Known Implementing Classes:

HTTPRequestImpl

public interface HTTPRequest

A parsed HTTP request (GET or POST). Request parameters are parameters encoded into the URI, or part of a POST form which is encoded as application/x-www-form-urlencoded. Parts are parameters (including files) uploaded in a POST in multipart/form-data. Use of the former encoding for POSTs is strongly discouraged as it has character set issues. We do support methods other than GET and POST for e.g. WebDAV, but they are not common.

Method Summary

Modifier and Type	Method and Description
void	freeParts() Free all the parts.
int	getContentLength() Get the length of the original uploaded raw data for a POST.
java.lang.String	getHeader(java.lang.String name) Get the value of a specific header on the request.
int	getIntParam(java.lang.String name) Get the value of a request parameter converted to an int, using 0 as default value.
int	getIntParam(java.lang.String name, int defaultValue) Get the value of a request parameter converted to an int, using the specified default value.
int	getIntPart(java.lang.String name, int defaultValue) Get a part as an integer with a default value if it is not set.
long	getLongParam(java.lang.String name, long defaultValue) Get a part as a long, with a default value if it is not set.
java.lang.String	getMethod() Get the HTTP method, typically GET or POST.
int[]	getMultipleIntParam(java.lang.String name) Get all values of a request parameter as int array, ignoring all values that can not be parsed.
java.lang.String[]	getMultipleParam(java.lang.String name) Get all values of a request parameter as a string array.
java.lang.String	getParam(java.lang.String name) Get the value of a request parameter, using an empty string as default value if the parameter was not set.
java.lang.String	getParam(java.lang.String name, java.lang.String defaultValue) Get the value of a request parameter, using the specified default value if the parameter was not set or has an empty value.
java.util.Collection<java.lang.String>	getParameterNames() Returns the names of all parameters.
RandomAccessBucket	getPart(java.lang.String name) Get a part as a Bucket.
byte[]	getPartAsBytes(java.lang.String name, int maxlength) Deprecated.
byte[]	getPartAsBytesFailsafe(java.lang.String name, int maxlength) Gets up to maxLength bytes from the part, ignores any bytes after the limit.
byte[]	getPartAsBytesThrowing(java.lang.String name, int maxlength)
java.lang.String	getPartAsString(java.lang.String name, int maxlength) Deprecated.
java.lang.String	getPartAsStringFailsafe(java.lang.String name, int maxlength) Gets up to maxLength characters from the part, ignores any characters after the limit.
java.lang.String	getPartAsStringThrowing(java.lang.String name, int maxlength)
java.lang.String[]	getParts()
java.lang.String	getPath() The path of this request, where the part of the path the specified the plugin has already been removed..
Bucket	getRawData() Get the original uploaded raw data for a POST.
HTTPUploadedFile	getUploadedFile(java.lang.String name) Get a file uploaded in the HTTP request.
boolean	hasParameters()
boolean	isChrome() Is the browser Chrome according to User-Agent?
boolean	isIncognito() Is the incognito=true boolean set? Sadly this does not prove that it is actually running incognito mode...
boolean	isParameterSet(java.lang.String name) Check if a parameter was set in the request at all, either with or without a value.
boolean	isPartSet(java.lang.String name) Is a part set with the given name?

Method Detail

getPath

java.lang.String getPath()

The path of this request, where the part of the path the specified the plugin has already been removed..

hasParameters

boolean hasParameters()

Returns:

false if the query string was totally empty

isParameterSet

boolean isParameterSet(java.lang.String name)

Check if a parameter was set in the request at all, either with or without a value.

Parameters:

name - the name of the parameter to check

Returns:

true if the parameter was set in the request, not regarding if the value is empty

getParam

java.lang.String getParam(java.lang.String name)

Get the value of a request parameter, using an empty string as default value if the parameter was not set. This method will never return null, so its safe to do things like

if (request.getParam("abc").equals("def"))

Parameters:

name - the name of the parameter to get

Returns:

the parameter value as String, or an empty String if the value was missing or empty

getParam

java.lang.String getParam(java.lang.String name,
                          java.lang.String defaultValue)

Get the value of a request parameter, using the specified default value if the parameter was not set or has an empty value.

Parameters:

name - the name of the parameter to get

defaultValue - the default value to be returned if the parameter is missing or empty

Returns:

either the parameter value as String, or the default value

getIntParam

int getIntParam(java.lang.String name)

Get the value of a request parameter converted to an int, using 0 as default value. If there are multiple values for this parameter, the first value is used.

Parameters:

name - the name of the parameter to get

Returns:

either the parameter value as int, or 0 if the parameter is missing, empty or invalid

getIntParam

int getIntParam(java.lang.String name,
                int defaultValue)

Get the value of a request parameter converted to an int, using the specified default value. If there are multiple values for this parameter, the first value is used.

Parameters:

name - the name of the parameter to get

defaultValue - the default value to be returned if the parameter is missing, empty or invalid

Returns:

either the parameter value as int, or the default value

getIntPart

int getIntPart(java.lang.String name,
               int defaultValue)

Get a part as an integer with a default value if it is not set.

getMultipleParam

java.lang.String[] getMultipleParam(java.lang.String name)

Get all values of a request parameter as a string array. If the parameter was not set at all, an empty array is returned, so this method will never return null.

Parameters:

name - the name of the parameter to get

Returns:

an array of all parameter values that might include empty values

getMultipleIntParam

int[] getMultipleIntParam(java.lang.String name)

Get all values of a request parameter as int array, ignoring all values that can not be parsed. If the parameter was not set at all, an empty array is returned, so this method will never return null.

Parameters:

name - the name of the parameter to get

Returns:

an int array of all parameter values that could be parsed as int

getUploadedFile

HTTPUploadedFile getUploadedFile(java.lang.String name)

Get a file uploaded in the HTTP request.

getPart

RandomAccessBucket getPart(java.lang.String name)

Get a part as a Bucket. Parts can be very large, as they are POST data from multipart/form-data and can include uploaded files.

isPartSet

boolean isPartSet(java.lang.String name)

Is a part set with the given name?

getPartAsString

@Deprecated
java.lang.String getPartAsString(java.lang.String name,
                                             int maxlength)

Deprecated.

Get a request part as a String. Parts are passed in through attached data in a POST in multipart/form-data encoding; parameters are passed in through the URI. Returns an empty String if the length limit is exceeded and therefore is deprecated.

getPartAsStringThrowing

java.lang.String getPartAsStringThrowing(java.lang.String name,
                                         int maxlength)
                                  throws java.util.NoSuchElementException,
                                         javax.naming.SizeLimitExceededException

Throws:

java.util.NoSuchElementException

javax.naming.SizeLimitExceededException

getPartAsStringFailsafe

java.lang.String getPartAsStringFailsafe(java.lang.String name,
                                         int maxlength)

Gets up to maxLength characters from the part, ignores any characters after the limit. If no such part exists, an empty String is returned.

getPartAsBytes

@Deprecated
byte[] getPartAsBytes(java.lang.String name,
                                  int maxlength)

Deprecated.

Get a request part as bytes. Returns an empty array if the length limit is exceeded and therefore is deprecated.

getPartAsBytesThrowing

byte[] getPartAsBytesThrowing(java.lang.String name,
                              int maxlength)
                       throws java.util.NoSuchElementException,
                              javax.naming.SizeLimitExceededException

Throws:

java.util.NoSuchElementException

javax.naming.SizeLimitExceededException

getPartAsBytesFailsafe

byte[] getPartAsBytesFailsafe(java.lang.String name,
                              int maxlength)

Gets up to maxLength bytes from the part, ignores any bytes after the limit. If no such part exists, a byte[] with size 0 is returned.

freeParts

void freeParts()

Free all the parts. They may be stored on disk so it is important that this be called at some point.

getLongParam

long getLongParam(java.lang.String name,
                  long defaultValue)

Get a part as a long, with a default value if it is not set.

getMethod

java.lang.String getMethod()

Get the HTTP method, typically GET or POST.

getRawData

Bucket getRawData()

Get the original uploaded raw data for a POST.

getHeader

java.lang.String getHeader(java.lang.String name)

Get the value of a specific header on the request.

getContentLength

int getContentLength()

Get the length of the original uploaded raw data for a POST.

getParts

java.lang.String[] getParts()

getParameterNames

java.util.Collection<java.lang.String> getParameterNames()

Returns the names of all parameters.

Returns:

The names of all parameters

isIncognito

boolean isIncognito()

Is the incognito=true boolean set? Sadly this does not prove that it is actually running incognito mode...

isChrome

boolean isChrome()

Is the browser Chrome according to User-Agent?