Interface FormDataParser
-
- All Superinterfaces:
AutoCloseable
,Closeable
public interface FormDataParser extends Closeable
Parser for form data. This can be used by down-stream handlers to parse form data.This parser must be closed to make sure any temporary files have been cleaned up.
- Author:
- Stuart Douglas
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Closes the parser, and removes and temporary files that may have been created.void
parse()
Parse the form data asynchronously.FormData
parseBlocking()
Parse the data, blocking the current thread until parsing is complete.void
setCharacterEncoding(String encoding)
Sets the character encoding that will be used by this parser.
-
-
-
Method Detail
-
parse
void parse() 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.The method can either invoke the next handler directly, or may delegate to the IO thread to perform the parsing.
- Throws:
Exception
-
parseBlocking
FormData parseBlocking() throws Exception
Parse the data, blocking the current thread until parsing is complete. For blocking handlers this method is more efficient than#parse(ResteasyReactiveRequestContext next)
, as the calling thread should do that actual parsing, rather than the read thread- Returns:
- The parsed form data
- Throws:
IOException
- If the data could not be readException
-
close
void close() throws IOException
Closes the parser, and removes and temporary files that may have been created.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
setCharacterEncoding
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
- The encoding
-
-