freenet.clients.http

Class HTTPRequestImpl

java.lang.Object

freenet.clients.http.HTTPRequestImpl

All Implemented Interfaces:

HTTPRequest

public class HTTPRequestImpl
extends java.lang.Object
implements HTTPRequest

Used for passing all HTTP request information to the FredPlugin that handles the request. It parses the query string and has several methods for accessing the request parameter values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPRequestImpl.HTTPUploadedFileImpl Container for uploaded files in HTTP POST requests.

Constructor Summary

Constructors

Constructor and Description
HTTPRequestImpl(java.lang.String path, java.lang.String encodedQueryString, java.lang.String method) Creates a new HTTPRequest for the given path and url-encoded query string
HTTPRequestImpl(java.net.URI uri, Bucket d, ToadletContext ctx, java.lang.String method) Creates a new HTTPRequest for the given URI and data.
HTTPRequestImpl(java.net.URI uri, java.lang.String method) Create a new HTTPRequest for the given URI and parse its request parameters.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createQueryString(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameterValues, boolean doUrlEncoding) Creates a query string from the given parameters.
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?
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	parseUriParameters(java.lang.String queryString, boolean doUrlDecoding) Parses the parameters from the given query string, optionally decoding the parameters using UTF-8.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPRequestImpl

public HTTPRequestImpl(java.net.URI uri,
                       java.lang.String method)

Create a new HTTPRequest for the given URI and parse its request parameters.

Parameters:

uri - the URI being requested

HTTPRequestImpl

public HTTPRequestImpl(java.lang.String path,
                       java.lang.String encodedQueryString,
                       java.lang.String method)
                throws java.net.URISyntaxException

Creates a new HTTPRequest for the given path and url-encoded query string

Parameters:

path - i.e. /test/test.html

encodedQueryString - a=some+text&b=abc%40def.de

Throws:

java.net.URISyntaxException - if the URI is invalid

HTTPRequestImpl

public HTTPRequestImpl(java.net.URI uri,
                       Bucket d,
                       ToadletContext ctx,
                       java.lang.String method)

Creates a new HTTPRequest for the given URI and data.

Parameters:

uri - The URI being requested

h - Client headers

d - The data

ctx - The toadlet context (for headers and bucket factory)

Throws:

java.net.URISyntaxException - if the URI is invalid

Method Detail

getPath

public java.lang.String getPath()

Description copied from interface: HTTPRequest

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

Specified by:

getPath in interface HTTPRequest

hasParameters

public boolean hasParameters()

Specified by:

hasParameters in interface HTTPRequest

Returns:

false if the query string was totally empty

getParameterNames

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

Returns the names of all parameters.

Specified by:

getParameterNames in interface HTTPRequest

Returns:

The names of all parameters

parseUriParameters

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> parseUriParameters(java.lang.String queryString,
                                                                                                  boolean doUrlDecoding)

Parses the parameters from the given query string, optionally decoding the parameters using UTF-8.

Parameters:

queryString - The query string to decode

doUrlDecoding - true to decode the parameter names and values

Returns:

The decoded parameters

createQueryString

public static java.lang.String createQueryString(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameterValues,
                                                 boolean doUrlEncoding)

Creates a query string from the given parameters.

Parameters:

parameterValues - The parameters to create a query string from

doUrlEncoding - true if encoding for HTTP headers, false to only encode unsafe characters

Returns:

The query string

isParameterSet

public boolean isParameterSet(java.lang.String name)

Description copied from interface: HTTPRequest

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

Specified by:

isParameterSet in interface HTTPRequest

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

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

Description copied from interface: HTTPRequest

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"))

Specified by:

getParam in interface HTTPRequest

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

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

Description copied from interface: HTTPRequest

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

Specified by:

getParam in interface HTTPRequest

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

public int getIntParam(java.lang.String name)

Description copied from interface: HTTPRequest

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.

Specified by:

getIntParam in interface HTTPRequest

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

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

Description copied from interface: HTTPRequest

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.

Specified by:

getIntParam in interface HTTPRequest

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

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

Description copied from interface: HTTPRequest

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

Specified by:

getIntPart in interface HTTPRequest

getMultipleParam

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

Description copied from interface: HTTPRequest

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.

Specified by:

getMultipleParam in interface HTTPRequest

Parameters:

name - the name of the parameter to get

Returns:

an array of all parameter values that might include empty values

getMultipleIntParam

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

Description copied from interface: HTTPRequest

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.

Specified by:

getMultipleIntParam in interface HTTPRequest

Parameters:

name - the name of the parameter to get

Returns:

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

getUploadedFile

public HTTPUploadedFile getUploadedFile(java.lang.String name)

Description copied from interface: HTTPRequest

Get a file uploaded in the HTTP request.

Specified by:

getUploadedFile in interface HTTPRequest

getPart

public RandomAccessBucket getPart(java.lang.String name)

Description copied from interface: HTTPRequest

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.

Specified by:

getPart in interface HTTPRequest

isPartSet

public boolean isPartSet(java.lang.String name)

Description copied from interface: HTTPRequest

Is a part set with the given name?

Specified by:

isPartSet in interface HTTPRequest

getPartAsString

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

Deprecated.

Description copied from interface: HTTPRequest

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.

Specified by:

getPartAsString in interface HTTPRequest

getPartAsStringThrowing

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

Specified by:

getPartAsStringThrowing in interface HTTPRequest

Throws:

java.util.NoSuchElementException

javax.naming.SizeLimitExceededException

getPartAsStringFailsafe

public java.lang.String getPartAsStringFailsafe(java.lang.String name,
                                                int maxLength)

Description copied from interface: HTTPRequest

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

Specified by:

getPartAsStringFailsafe in interface HTTPRequest

getPartAsBytes

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

Deprecated.

Description copied from interface: HTTPRequest

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

Specified by:

getPartAsBytes in interface HTTPRequest

getPartAsBytesThrowing

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

Specified by:

getPartAsBytesThrowing in interface HTTPRequest

Throws:

java.util.NoSuchElementException

javax.naming.SizeLimitExceededException

getPartAsBytesFailsafe

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

Description copied from interface: HTTPRequest

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.

Specified by:

getPartAsBytesFailsafe in interface HTTPRequest

freeParts

public void freeParts()

Description copied from interface: HTTPRequest

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

Specified by:

freeParts in interface HTTPRequest

getLongParam

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

Description copied from interface: HTTPRequest

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

Specified by:

getLongParam in interface HTTPRequest

getMethod

public java.lang.String getMethod()

Description copied from interface: HTTPRequest

Get the HTTP method, typically GET or POST.

Specified by:

getMethod in interface HTTPRequest

getRawData

public Bucket getRawData()

Description copied from interface: HTTPRequest

Get the original uploaded raw data for a POST.

Specified by:

getRawData in interface HTTPRequest

getHeader

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

Description copied from interface: HTTPRequest

Get the value of a specific header on the request.

Specified by:

getHeader in interface HTTPRequest

getContentLength

public int getContentLength()

Description copied from interface: HTTPRequest

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

Specified by:

getContentLength in interface HTTPRequest

getParts

public java.lang.String[] getParts()

Specified by:

getParts in interface HTTPRequest

isIncognito

public boolean isIncognito()

Description copied from interface: HTTPRequest

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

Specified by:

isIncognito in interface HTTPRequest

isChrome

public boolean isChrome()

Description copied from interface: HTTPRequest

Is the browser Chrome according to User-Agent?

Specified by:

isChrome in interface HTTPRequest