org.apache.juneau.rest

Class RequestFormData

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,String[]>

org.apache.juneau.rest.RequestFormData

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String[]>

public class RequestFormData
extends LinkedHashMap<String,String[]>

Represents the parsed form-data parameters in an HTTP request.

Similar in functionality to the ServletRequest.getParameter(String) except only looks in the body of the request, not parameters from the URL query string.
This can be useful in cases where you're using GET parameters on FORM POSTs, and you don't want the body of the request to be read.

Use of this object is incompatible with using any other methods that access the body of the request (since this object will consume the body).
Some examples:

• RestRequest.getBody()
• RestRequest.getReader()
• RestRequest.getInputStream()
• Header

See Also:

• Overview > juneau-rest-server > RequestFormData

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
RequestFormData()

Method Summary

Modifier and Type	Method and Description
RequestFormData	addDefault(Map<String,Object> defaultEntries) Adds default entries to these form-data parameters.
RequestFormData	addDefault(String name, Object value) Adds a default entries to these form-data parameters.
<T> T	get(HttpPartParser parser, String name, Class<T> type) Same as get(String, Object, Class) but allows you to override the part parser.
<T> T	get(HttpPartParser parser, String name, T def, Class<T> type) Same as get(String, Object, Class) but allows you to override the part parser.
<T> T	get(HttpPartParser parser, String name, Type type, Type... args) Same as get(String, Type, Type...) but allows you to override the part parser.
<T> T	get(String name, Class<T> type) Returns the specified form-data parameter value converted to a POJO using the HttpPartParser registered with the resource.
<T> T	get(String name, T def, Class<T> type) Same as get(String, Class) except returns a default value if not specified.
<T> T	get(String name, Type type, Type... args) Returns the specified form-data parameter value converted to a POJO using the HttpPartParser registered with the resource.
<T> T	getAll(HttpPartParser parser, String name, Class<T> type) Same as getAll(String, Class) but allows you to override the part parser.
<T> T	getAll(HttpPartParser parser, String name, Type type, Type... args) Same as getAll(String, Type, Type...) but allows you to override the part parser.
<T> T	getAll(String name, Class<T> type) Same as get(String, Class) except for use on multi-part parameters (e.g.
<T> T	getAll(String name, Type type, Type... args) Same as get(String, Type, Type...) except for use on multi-part parameters (e.g.
boolean	getBoolean(String name) Same as getString(String) but converts the value to a boolean.
boolean	getBoolean(String name, boolean def) Same as getString(String,String) but converts the value to a boolean.
int	getInt(String name) Same as getString(String) but converts the value to an integer.
int	getInt(String name, int def) Same as getString(String,String) but converts the value to an integer.
String	getString(String name) Returns a form-data parameter value.
String	getString(String name, String def) Same as getString(String) except returns a default value if null or empty.
void	put(String name, Object value) Sets a request form-data parameter value.
String	toString()
String	toString(boolean sorted) Converts the form-data parameters to a readable string.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

RequestFormData

public RequestFormData()

Method Detail

addDefault

public RequestFormData addDefault(Map<String,Object> defaultEntries)

Adds default entries to these form-data parameters.

This includes the default form-data parameters defined on the resource and method levels.

Parameters:

defaultEntries - The default entries.
Can be null.

Returns:

This object (for method chaining).

addDefault

public RequestFormData addDefault(String name,
                                  Object value)

Adds a default entries to these form-data parameters.

Similar to put(String, Object) but doesn't override existing values.

Parameters:

name - The form-data parameter name.

value - The form-data parameter value.
Converted to a String using toString().
Ignored if value is null or blank.

Returns:

This object (for method chaining).

put

public void put(String name,
                Object value)

Sets a request form-data parameter value.

Parameters:

name - The parameter name.

value - The parameter value.

getString

public String getString(String name)

Returns a form-data parameter value.

Parameter lookup is case-insensitive (consistent with WAS, but differs from Tomcat).

Notes:

• This method returns the raw unparsed value, and differs from calling get(name, String.class) which will convert the value from UON notation:
  • "null" => null
  • "'null'" => "null"
  • "'foo bar'" => "foo bar"
  • "foo~~bar" => "foo~bar"

Parameters:

name - The form-data parameter name.

Returns:

The parameter value, or null if parameter does not exist.

getString

public String getString(String name,
                        String def)

Same as getString(String) except returns a default value if null or empty.

Parameters:

name - The form-data parameter name.

def - The default value.

Returns:

The parameter value, or the default value if parameter does not exist or is null or empty.

getInt

public int getInt(String name)

Same as getString(String) but converts the value to an integer.

Parameters:

name - The form-data parameter name.

Returns:

The parameter value, or 0 if parameter does not exist or is null or empty.

getInt

public int getInt(String name,
                  int def)

Same as getString(String,String) but converts the value to an integer.

Parameters:

name - The form-data parameter name.

def - The default value.

Returns:

The parameter value, or the default value if parameter does not exist or is null or empty.

getBoolean

public boolean getBoolean(String name)

Same as getString(String) but converts the value to a boolean.

Parameters:

name - The form-data parameter name.

Returns:

The parameter value, or false if parameter does not exist or is null or empty.

getBoolean

public boolean getBoolean(String name,
                          boolean def)

Same as getString(String,String) but converts the value to a boolean.

Parameters:

name - The form-data parameter name.

def - The default value.

Returns:

The parameter value, or the default value if parameter does not exist or is null or empty.

get

public <T> T get(String name,
                 Class<T> type)
          throws ParseException

Returns the specified form-data parameter value converted to a POJO using the HttpPartParser registered with the resource.

Examples:

// Parse into an integer. int myparam = formData.get("myparam", int.class); // Parse into an int array. int[] myparam = formData.get("myparam", int[].class); // Parse into a bean. MyBean myparam = formData.get("myparam", MyBean.class); // Parse into a linked-list of objects. List myparam = formData.get("myparam", LinkedList.class); // Parse into a map of object keys/values. Map myparam = formData.get("myparam", TreeMap.class);

See Also:

• RestContext.REST_partParser

Type Parameters:

T - The class type to convert the parameter value to.

Parameters:

name - The parameter name.

type - The class type to convert the parameter value to.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(HttpPartParser parser,
                 String name,
                 Class<T> type)
          throws ParseException

Same as get(String, Object, Class) but allows you to override the part parser.

Type Parameters:

T - The class type to convert the parameter value to.

Parameters:

parser - The parser to use for parsing the string value.
If null, uses the part parser defined on the resource/method.

name - The parameter name.

type - The class type to convert the parameter value to.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(String name,
                 T def,
                 Class<T> type)
          throws ParseException

Same as get(String, Class) except returns a default value if not specified.

Type Parameters:

T - The class type to convert the parameter value to.

Parameters:

name - The parameter name.

def - The default value if the parameter was not specified or is null.

type - The class type to convert the parameter value to.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(HttpPartParser parser,
                 String name,
                 T def,
                 Class<T> type)
          throws ParseException

Same as get(String, Object, Class) but allows you to override the part parser.

Type Parameters:

T - The class type to convert the parameter value to.

Parameters:

parser - The parser to use for parsing the string value.
If null, uses the part parser defined on the resource/method.

name - The parameter name.

def - The default value if the parameter was not specified or is null.

type - The class type to convert the parameter value to.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

getAll

public <T> T getAll(String name,
                    Class<T> type)
             throws ParseException

Same as get(String, Class) except for use on multi-part parameters (e.g. "key=1&key=2&key=3" instead of "key=@(1,2,3)")

This method must only be called when parsing into classes of type Collection or array.

Parameters:

name - The parameter name.

type - The class type to convert the parameter value to.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

getAll

public <T> T getAll(HttpPartParser parser,
                    String name,
                    Class<T> type)
             throws ParseException

Same as getAll(String, Class) but allows you to override the part parser.

This method must only be called when parsing into classes of type Collection or array.

Parameters:

parser - The parser to use for parsing the string value.
If null, uses the part parser defined on the resource/method.

name - The parameter name.

type - The class type to convert the parameter value to.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(String name,
                 Type type,
                 Type... args)
          throws ParseException

Returns the specified form-data parameter value converted to a POJO using the HttpPartParser registered with the resource.

Similar to get(String,Class) but allows for complex collections of POJOs to be created.

Examples:

// Parse into a linked-list of strings. List<String> myparam = formData.get("myparam", LinkedList.class, String.class); // Parse into a linked-list of linked-lists of strings. List<List<String>> myparam = formData.get("myparam", LinkedList.class, LinkedList.class, String.class); // Parse into a map of string keys/values. Map<String,String> myparam = formData.getr("myparam", TreeMap.class, String.class, String.class); // Parse into a map containing string keys and values of lists containing beans. Map<String,List<MyBean>> myparam = formData.get("myparam", TreeMap.class, String.class, List.class, MyBean.class);

Notes:

• Collections must be followed by zero or one parameter representing the value type.
• Maps must be followed by zero or two parameters representing the key and value types.

See Also:

• RestContext.REST_partParser

Parameters:

name - The parameter name.

type - The type of object to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(HttpPartParser parser,
                 String name,
                 Type type,
                 Type... args)
          throws ParseException

Same as get(String, Type, Type...) but allows you to override the part parser.

Parameters:

parser - The parser to use for parsing the string value.
If null, uses the part parser defined on the resource/method.

name - The parameter name.

type - The type of object to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

getAll

public <T> T getAll(String name,
                    Type type,
                    Type... args)
             throws ParseException

Same as get(String, Type, Type...) except for use on multi-part parameters (e.g. "key=1&key=2&key=3" instead of "key=@(1,2,3)")

This method must only be called when parsing into classes of type Collection or array.

Parameters:

name - The parameter name.

type - The type of object to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

getAll

public <T> T getAll(HttpPartParser parser,
                    String name,
                    Type type,
                    Type... args)
             throws ParseException

Same as getAll(String, Type, Type...) but allows you to override the part parser.

Parameters:

parser - The parser to use for parsing the string value.
If null, uses the part parser defined on the resource/method.

name - The parameter name.

type - The type of object to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The parameter value converted to the specified class type.

Throws:

ParseException

toString

public String toString(boolean sorted)

Converts the form-data parameters to a readable string.

Parameters:

sorted - Sort the form-data parameters by name.

Returns:

A JSON string containing the contents of the form-data parameters.

toString

public String toString()

Overrides:

toString in class AbstractMap<String,String[]>