org.apache.juneau.rest.annotation

Annotation Type HasFormData

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

Annotation that can be applied to a parameter of a @RestMethod annotated method to identify whether or not the request has the specified multipart form POST parameter.

Note that this can be used to detect the existence of a parameter when it's not set to a particular value.

Example:

@RestMethod(name=POST) public void doPost(@HasFormData("p1") boolean p1) { ... }

This is functionally equivalent to the following code...

@RestMethod(name=POST) public void doPost(RestRequest req) { boolean p1 = req.hasFormData("p1"); ... }

The following table shows the behavioral differences between @HasFormData and @FormData...

Body content	@HasFormData("a")	@FormData("a")
a=foo	true	"foo"
a=	true	""
a	true	null
b=foo	false	null

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 @HasQuery annotation can be used to check for the existing of 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	name FORM parameter name.
String	value A synonym for name().

Element Detail

name

public abstract String name

FORM parameter name.

Default:

""

value

public abstract String value

A synonym for name().

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

Default:

""