Undertow 2.3.12.Final · io.undertow.server.handlers.form.FormDataParser

Modifier and Type	Field and Description
public static final AttachmentKey<FormData>	FORM_DATA When the form data is parsed it will be attached under this key.

Method Summary

Modifier and Type	Method and Description
public void	close() Redeclares java.io.Closeable.close. Closes the parser, and removes and temporary files that may have been created.
public void	parse(final HttpHandler next) Parse the form data asynchronously.
public FormData	Returns: The parsed form data parseBlocking() Parse the data, blocking the current thread until parsing is complete.
public void	setCharacterEncoding(String The encoding encoding) Sets the character encoding that will be used by this parser.

FORM_DATA	back to summary
public static final AttachmentKey<FormData> FORM_DATA When the form data is parsed it will be attached under this key.

Method Detail

close	back to summary
public void close() throws IOException Redeclares java.io.Closeable.close. Closes the parser, and removes and temporary files that may have been created. Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

back to summary

public void close() throws IOException

Redeclares java.io.Closeable.close.

Closes the parser, and removes and temporary files that may have been created.

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

parse back to summary

parse	back to summary
public void parse(final HttpHandler next) throws Exception Parse the form data asynchronously. If all the data cannot be read immediately then a read listener will be registered, and the data will be parsed by the read thread. When this method completes the handler will be invoked, and the data will be attached under `FORM_DATA`. The method can either invoke the next handler directly, or may delegate to the IO thread to perform the parsing.

public void parse(final HttpHandler next) throws Exception

Parse the form data asynchronously. If all the data cannot be read immediately then a read listener will be registered, and the data will be parsed by the read thread.

When this method completes the handler will be invoked, and the data will be attached under FORM_DATA.

The method can either invoke the next handler directly, or may delegate to the IO thread to perform the parsing.

parseBlocking back to summary

parseBlocking	back to summary
public FormData parseBlocking() throws IOException Parse the data, blocking the current thread until parsing is complete. For blocking handlers this method is more efficient than `parse(io.undertow.server.HttpHandler next)`, as the calling thread should do that actual parsing, rather than the read thread Returns:FormData The parsed form data Exceptions IOException: If the data could not be read

public FormData parseBlocking() throws IOException

Parse the data, blocking the current thread until parsing is complete. For blocking handlers this method is more efficient than parse(io.undertow.server.HttpHandler next), as the calling thread should do that actual parsing, rather than the read thread

Returns:FormData

The parsed form data

Exceptions

IOException:: If the data could not be read

setCharacterEncoding	back to summary
public void setCharacterEncoding(String encoding) Sets the character encoding that will be used by this parser. If the request is already processed this will have no effect Parameters encoding:String The encoding

setCharacterEncoding

back to summary

public void setCharacterEncoding(String encoding)

Sets the character encoding that will be used by this parser. If the request is already processed this will have no effect

Parameters

encoding:String: The encoding

public Interface FormDataParser

Field Summary

Method Summary

Field Detail

Method Detail