In JAX-RS, we can use @FormParam annotation to bind HTML form parameters value to a Java method. MSF4J supports below content types for FormParam
- application/x-www-form-urlencoded
- multipart/form-data
This is pretty much similar to the QueryParam. MSF4J reads the Request body and get the decode the encoded values and pass the values to the service.
E.g. Sample service for application/x-www-form-urlencoded content type
@POST
@Path("/formParam")
public Response testFormParam(@FormParam("age") int age, @FormParam("name") String name) {
System.out.println("Name " + name);
System.out.println("Age" + age);
return Response.ok().entity("Name and age " + name + ", " + age).build();
}Parameters should be based on http://docs.oracle.com/javaee/7/api/javax/ws/rs/FormParam.html
@POST
@Path("/formParam")
@Consumes({MediaType.APPLICATION_FORM_URLENCODED, MediaType.MULTIPART_FORM_DATA})
public Response testFormParam(@FormParam("age") int age, @FormParam("name") String name) {
System.out.println("Name " + name);
System.out.println("Age" + age);
return Response.ok().entity("Name and age " + name + ", " + age).build();
}If a user wants, MSF4J will not process the stream but rather directly pass an FormParamIterator which can be used to retrieve the parameter values. You can inject that with @Context annotation. Type must be FormParamIterator. e.g.
public Response simpleFormStreaming(@Context FormParamIterator formParamIterator) {FormParamIterator.next() and FormParamIterator.hasNext() method can be used to retrieve and check if more items are available. FormParamIterator.next() returns a FormItem object which is corresponding to a item in the form. FormItem.openStream() returns an InputStream for the particular item of the form. FormItem.getContentType() returns the content type of the item FormItem.getFieldName() returns the name of the item
E.g. Sample service for multipart/form-data content-type with file upload
@POST
@Path("/simpleFormStreaming")
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response simpleFormStreaming(@Context FormParamIterator formParamIterator) {
try {
while (formParamIterator.hasNext()) {
FormItem item = formParamIterator.next();
if (item.isFormField()) {
System.out.println(item.getFieldName() + " - " + StreamUtil.asString(item.openStream()));
} else {
Files.copy(item.openStream(), Paths.get(System.getProperty("java.io.tmpdir"), item.getName()));
}
}
} catch (FileUploadException e) {
log.error("Error while uploading the file " + e.getMessage(), e);
} catch (IOException e) {
log.error("Unable to upload the file " + e.getMessage(), e);
}
return Response.ok().entity("Request completed").build();
}If you like use non streaming mode then you can directly get File objects in a file upload. Here rather than @FormParam you need to use @FormDataParam annotation. This annotation can be used with all FormParam supported data types plus File and bean types as well as InputStreams.
If you want to upload set of files. Then a sample service would be like as follows:
@POST
@Path("/multipleFiles")
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response multipleFiles(@FormDataParam("files") List<File> files) {
files.forEach(file -> {
try {
Files.copy(file.toPath(), Paths.get(System.getProperty("java.io.tmpdir"), file.getName()));
} catch (IOException e) {
log.error("Error while Copying the file " + e.getMessage(), e);
}
});
return Response.ok().entity("Request completed").build();
}You can use more complex times with combination of primitives, beans and files as follows
@POST
@Path("/complexForm")
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response complexForm(@FormDataParam("file") File file,
@FormDataParam("id") int id,
@FormDataParam("people") List<Person> personList,
@FormDataParam("company") Company animal) {
System.out.println("First Person in List " + personList.get(0).getName());
System.out.println("Id " + id);
System.out.println("Company " + animal.getType());
try {
Files.copy(file.toPath(), Paths.get(System.getProperty("java.io.tmpdir"), file.getName()));
} catch (IOException e) {
log.error("Error while Copying the file " + e.getMessage(), e);
}
return Response.ok().entity("Request completed").build();
}If you like to get the InputStream of a file then you can go ahead like below example. There FileInfo bean will hold the filename and the content type attributes of the particular inputstream. Note that attribute names must be equal when you use InpuStream. Here I’ve used ‘file’ for the both params.
@POST
@Path("/streamFile")
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response multipleFiles(@FormDataParam("file") FileInfo fileInfo,
@FormDataParam("file") InputStream inputStream) {
try {
Files.copy(inputStream, Paths.get(System.getProperty("java.io.tmpdir"), fileInfo.getFileName()));
} catch (IOException e) {
log.error("Error while Copying the file " + e.getMessage(), e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build();
} finally {
IOUtils.closeQuietly(inputStream);
}
return Response.ok().entity("Request completed").build();
}This is the MSF4J sample which demonstrate how to use FormParam.
From this directory, run
mvn clean install
From this directory, run
java -jar target/formparam-*.jar
We will use the cURL command line tool for testing. You can use your preferred HTTP or REST client too. Simple client is also available in the sample
- For simpleForm and simpleFormWithFormParam operations in the FormService. Change the url based on the operations you invoke
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'name=WSO2&age=10' "http://localhost:8080/formService/simpleFormWithFormParam"
curl -X POST -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "name=WSO2" -F "age=10" "http://localhost:8080/formService/simpleFormWithFormParam"
- For simpleFormWithFormParamAndList, simpleFormWithFormParamAndSet and simpleFormWithFormParamAndSortedSet operations in the FormService. Change the url based on the operations you invoke
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'name=WSO2&name=IBM' "http://localhost:8080/formService/simpleFormWithFormParamAndList"
curl -X POST -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "name=WSO2" -F "name=IBM" -F "name=Oracle" "http://localhost:8080/formService/simpleFormWithFormParamAndList"
- For simpleFormStreaming operation in the FormService
curl -X POST -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "name=WSO2" -F "age=10" -F "[email protected]" "http://localhost:8080/formService/simpleFormStreaming"
You can also use a simple html form like below or a rest client e.g. Postman, Advanced RestClient
<form method="post" action="http://localhost:8080/formService/simpleFormStreaming">
<table>
<tr>
<td>Name:</td>
<td><input type="text" name="name" /></td>
</tr>
<tr>
<td>Age:</td>
<td><input type="text" name="age" /></td>
</tr>
<tr>
<td>Photo:</td>
<td><input type="file" name="photo" /></td>
</tr>
<tr>
<td colspan="1"><input name="submit" type="submit" value="Add User" /></td>
</tr>
</table>
</form>- For multipleFiles operation in the FormService
curl -X POST -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "[email protected]" -F "files=file2.jpg" "http://localhost:8080/formService/multipleFiles"
- For streamFile operation in the FormService
curl -X POST -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "file=file1.txt" "http://localhost:8080/formService/streamFile"
Please refer to the SampleClient code to invoke the complexForm operation