Package org.apache.juneau.rest.httppart

Class RequestFormParams

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<RequestFormParam>

org.apache.juneau.rest.httppart.RequestFormParams

All Implemented Interfaces:

Serializable, Cloneable, Iterable<RequestFormParam>, Collection<RequestFormParam>, List<RequestFormParam>, RandomAccess

public class RequestFormParams
extends ArrayList<RequestFormParam>

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

The RequestFormParams object is the API for accessing the HTTP request content as form data. It can be accessed by passing it as a parameter on your REST Java method:

@RestPost(...) public Object myMethod(RequestFormParams formData) {...}

Example:

@RestPost(...) public Object myMethod(RequestFormParams formData) { // Get query parameters converted to various types. int p1 = formData.get("p1").asInteger().orElse(0); String p2 = formData.get("p2").orElse(null); UUID p3 = formData.get("p3").as(UUID.class).orElse(null); }

Note that this object does NOT take GET parameters into account and only returns values found in the content of the request.

Some important methods on this class are:

• RequestFormParams
  • Methods for retrieving form data parameters:
    • contains(String)
    • containsAny(String...)
    • get(Class)
    • get(String)
    • getAll(String)
    • getFirst(String)
    • getLast(String)
  • Methods overridding form data parameters:
    • add(NameValuePair...)
    • add(Part)
    • add(String,Object)
    • addDefault(List)
    • addDefault(NameValuePair...)
    • addDefault(String,String)
    • remove(String)
    • set(NameValuePair...)
    • set(String,Object)
  • Other methods:
    • asQueryString()
    • copy()
    • isEmpty()

See Also:

• RequestFormParam
• FormData
• HasFormData
• HTTP Parts

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
RequestFormParams(RestRequest req, boolean caseSensitive)	Constructor.

Method Summary

Modifier and Type	Method	Description
RequestFormParams	add(jakarta.servlet.http.Part part)	Adds a parameter value.
RequestFormParams	add(String name, Object value)	Adds a parameter value.
RequestFormParams	add(NameValuePair... parameters)	Adds request parameter values.
RequestFormParams	addDefault(String name, String value)	Adds a default entry to the form data parameters.
RequestFormParams	addDefault(List<? extends NameValuePair> pairs)	Adds default entries to these parameters.
RequestFormParams	addDefault(NameValuePair... pairs)	Adds default entries to these parameters.
String	asQueryString()	Converts this object to a query string.
RequestFormParams	caseSensitive(boolean value)	Sets case sensitivity for names in this list.
boolean	contains(String name)	Returns true if the parameters with the specified names are present.
boolean	containsAny(String... names)	Returns true if the parameter with any of the specified names are present.
RequestFormParams	copy()	Makes a copy of these parameters.
<T> Optional<T>	get(Class<T> type)	Returns the form data parameter as the specified bean type.
RequestFormParam	get(String name)	Returns the last parameter with the specified name.
List<RequestFormParam>	getAll(String name)	Returns all the parameters with the specified name.
RequestFormParam	getFirst(String name)	Returns the first parameter with the specified name.
RequestFormParam	getLast(String name)	Returns the last parameter with the specified name.
List<String>	getNames()	Returns all the unique header names in this list.
Stream<RequestFormParam>	getSorted()	Returns all headers in sorted order.
RequestFormParams	parser(HttpPartParserSession value)	Sets the parser to use for part values.
RequestFormParams	remove(String name)	Remove parameters.
RequestFormParams	set(String name, Object value)	Sets a parameter value.
RequestFormParams	set(NameValuePair... parameters)	Sets request header values.
Stream<RequestFormParam>	stream(String name)	Returns all headers with the specified name.
RequestFormParams	subset(String... names)	Returns a copy of this object but only with the specified param names copied.
String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

RequestFormParams

public RequestFormParams(RestRequest req,
 boolean caseSensitive)
                  throws Exception

Constructor.

Parameters:

req - The request creating this bean.

caseSensitive - Whether case-sensitive name matching is enabled.

Throws:

Exception - Any exception can be thrown.

Method Details

parser

public RequestFormParams parser(HttpPartParserSession value)

Sets the parser to use for part values.

Parameters:

value - The new value for this setting.

Returns:

This object.

caseSensitive

public RequestFormParams caseSensitive(boolean value)

Sets case sensitivity for names in this list.

Parameters:

value - The new value for this setting.

Returns:

This object (for method chaining).

addDefault

public RequestFormParams addDefault(List<? extends NameValuePair> pairs)

Adds default entries to these parameters.

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

Parameters:

pairs - The default entries.
Can be null.

Returns:

This object.

addDefault

public RequestFormParams addDefault(NameValuePair... pairs)

Adds default entries to these parameters.

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

Parameters:

pairs - The default entries.
Can be null.

Returns:

This object.

addDefault

public RequestFormParams addDefault(String name,
 String value)

Adds a default entry to the form data parameters.

Parameters:

name - The name.

value - The value.

Returns:

This object.

add

public RequestFormParams add(String name,
 Object value)

Adds a parameter value.

Parameter is added to the end.
Existing parameter with the same name are not changed.

Parameters:

name - The parameter name. Must not be null.

value - The parameter value.

Returns:

This object.

add

public RequestFormParams add(NameValuePair... parameters)

Adds request parameter values.

Parameters are added to the end.
Existing parameters with the same name are not changed.

Parameters:

parameters - The parameter objects. Must not be null.

Returns:

This object.

add

public RequestFormParams add(jakarta.servlet.http.Part part)

Adds a parameter value.

Parameter is added to the end.
Existing parameter with the same name are not changed.

Parameters:

part - The parameter part. Must not be null.

Returns:

This object.

set

public RequestFormParams set(String name,
 Object value)

Sets a parameter value.

Parameter is added to the end.
Any previous parameters with the same name are removed.

Parameters:

name - The parameter name. Must not be null.

value - The parameter value.
Converted to a string using Object.toString().
Can be null.

Returns:

This object.

set

public RequestFormParams set(NameValuePair... parameters)

Sets request header values.

Parameters are added to the end of the headers.
Any previous parameters with the same name are removed.

Parameters:

parameters - The parameters to set. Must not be null or contain null.

Returns:

This object.

remove

public RequestFormParams remove(String name)

Remove parameters.

Parameters:

name - The parameter names. Must not be null.

Returns:

This object.

subset

public RequestFormParams subset(String... names)

Returns a copy of this object but only with the specified param names copied.

Parameters:

names - The list to include in the copy.

Returns:

A new list object.

contains

public boolean contains(String name)

Returns true if the parameters with the specified names are present.

Parameters:

name - The parameter name. Must not be null.

Returns:

true if the parameters with the specified names are present.

containsAny

public boolean containsAny(String... names)

Returns true if the parameter with any of the specified names are present.

Parameters:

names - The parameter names. Must not be null.

Returns:

true if the parameter with any of the specified names are present.

getAll

public List<RequestFormParam> getAll(String name)

Returns all the parameters with the specified name.

Parameters:

name - The parameter name.

Returns:

The list of all parameters with the specified name, or an empty list if none are found.

stream

public Stream<RequestFormParam> stream(String name)

Returns all headers with the specified name.

Parameters:

name - The header name.

Returns:

The stream of all headers with matching names. Never null.

getSorted

public Stream<RequestFormParam> getSorted()

Returns all headers in sorted order.

Returns:

The stream of all headers in sorted order.

getNames

public List<String> getNames()

Returns all the unique header names in this list.

Returns:

The list of all unique header names in this list.

getFirst

public RequestFormParam getFirst(String name)

Returns the first parameter with the specified name.

Note that this method never returns null and that RequestHttpPart.isPresent() can be used to test for the existence of the parameter.

Parameters:

name - The parameter name.

Returns:

The parameter. Never null.

getLast

public RequestFormParam getLast(String name)

Returns the last parameter with the specified name.

Note that this method never returns null and that RequestHttpPart.isPresent() can be used to test for the existence of the parameter.

Parameters:

name - The parameter name.

Returns:

The parameter. Never null.

get

public RequestFormParam get(String name)

Returns the last parameter with the specified name.

This is equivalent to getLast(String).

Parameters:

name - The parameter name.

Returns:

The parameter value, or Optional.empty() if it doesn't exist.

get

public <T> Optional<T> get(Class<T> type)

Returns the form data parameter as the specified bean type.

Type must have a name specified via the FormData annotation and a public constructor that takes in either value or name,value as strings.

Type Parameters:

T - The bean type to create.

Parameters:

type - The bean type to create.

Returns:

The bean, never null.

asQueryString

public String asQueryString()

Converts this object to a query string.

Returned query string does not start with '?'.

Returns:

A new query string, or an empty string if this object is empty.

copy

public RequestFormParams copy()

Makes a copy of these parameters.

Returns:

A new parameters object.

toString

public String toString()

Overrides:

toString in class AbstractCollection<RequestFormParam>