org.apache.juneau.rest.annotation

Annotation Type FormData

@Documented
 @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Inherited
public @interface FormData

Annotation that can be applied to a parameter of a @RestMethod annotated method to identify it as a form post entry converted to a POJO.

Example:

@RestMethod(name=POST) public void doPost(RestRequest req, RestResponse res, @FormData("p1") int p1, @FormData("p2") String p2, @FormData("p3") UUID p3) { ... }

This is functionally equivalent to the following code...

@RestMethod(name=POST) public void doPost(RestRequest req, RestResponse res) { int p1 = req.getFormData(int.class, "p1", 0); String p2 = req.getFormData(String.class, "p2"); UUID p3 = req.getFormData(UUID.class, "p3"); ... }

Important note concerning FORM posts

This annotation should not be combined with the @Body annotation or RestRequest.getBody() method for application/x-www-form-urlencoded POST posts, since it will trigger the underlying servlet API to parse the body content as key-value pairs resulting in empty content.

The @Query annotation can be used to retrieve a URL parameter in the URL string without triggering the servlet to drain the body content.

See Also:

• Overview > juneau-rest-server > @FormData

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	def The default value for this form-data parameter if it's not present in the request.
boolean	multipart Specify true if using multi-part parameters to represent collections and arrays.
String	name FORM parameter name.
Class<? extends HttpPartParser>	parser Specifies the HttpPartParser class used for parsing values from strings.
String	value A synonym for name().

Element Detail

def

public abstract String def

The default value for this form-data parameter if it's not present in the request.

Default:

""

multipart

public abstract boolean multipart

Specify true if using multi-part parameters to represent collections and arrays.

Normally, we expect single parameters to be specified in UON notation for representing collections of values (e.g. "key=(1,2,3)". This annotation allows the use of multi-part parameters to represent collections (e.g. "key=1&key=2&key=3".

This setting should only be applied to Java parameters of type array or Collection.

Default:

false

name

public abstract String name

FORM parameter name.

Default:

""

parser

public abstract Class<? extends HttpPartParser> parser

Specifies the HttpPartParser class used for parsing values from strings.

The default value for this parser is inherited from the servlet/method which defaults to UonPartParser.
You can use SimplePartParser to parse POJOs that are directly convertible from Strings.

Default:

org.apache.juneau.httppart.HttpPartParser.Null.class

value

public abstract String value

A synonym for name().

Allows you to use shortened notation if you're only specifying the name.

Default:

""