public interface BodyHandler extends Handler<RoutingContext>
RoutingContext
.
It also handles HTTP file uploads and can be used to limit body sizes.
Modifier and Type | Field and Description |
---|---|
static long |
DEFAULT_BODY_LIMIT
Default max size for a request body =
-1 means unlimited |
static boolean |
DEFAULT_DELETE_UPLOADED_FILES_ON_END
Default value of whether uploaded files should be removed after handling the request
|
static boolean |
DEFAULT_MERGE_FORM_ATTRIBUTES
Default value of whether form attributes should be merged into request params
|
static boolean |
DEFAULT_PREALLOCATE_BODY_BUFFER
Default value of whether to pre-allocate the body buffer size according to the content-length HTTP request header
|
static String |
DEFAULT_UPLOADS_DIRECTORY
Default uploads directory on server for file uploads
|
Modifier and Type | Method and Description |
---|---|
static BodyHandler |
create()
Create a body handler with defaults
|
static BodyHandler |
create(boolean handleFileUploads)
Create a body handler setting if it should handle file uploads
|
static BodyHandler |
create(String uploadDirectory)
Create a body handler and use the given upload directory.
|
BodyHandler |
setBodyLimit(long bodyLimit)
Set the maximum body size in bytes,
-1 means no limit |
BodyHandler |
setDeleteUploadedFilesOnEnd(boolean deleteUploadedFilesOnEnd)
Set whether uploaded files should be removed after handling the request
|
BodyHandler |
setHandleFileUploads(boolean handleFileUploads)
Set whether file uploads will be handled
|
BodyHandler |
setMergeFormAttributes(boolean mergeFormAttributes)
Set whether form attributes will be added to the request parameters
|
BodyHandler |
setPreallocateBodyBuffer(boolean isPreallocateBodyBuffer)
Pre-allocate the body buffer according to the value parsed from content-length header.
|
BodyHandler |
setUploadsDirectory(String uploadsDirectory)
Set the uploads directory to use
|
static final long DEFAULT_BODY_LIMIT
-1
means unlimitedstatic final String DEFAULT_UPLOADS_DIRECTORY
static final boolean DEFAULT_MERGE_FORM_ATTRIBUTES
static final boolean DEFAULT_DELETE_UPLOADED_FILES_ON_END
static final boolean DEFAULT_PREALLOCATE_BODY_BUFFER
static BodyHandler create()
static BodyHandler create(boolean handleFileUploads)
handleFileUploads
- true if files upload should be handledstatic BodyHandler create(String uploadDirectory)
uploadDirectory
- the uploads directoryBodyHandler setHandleFileUploads(boolean handleFileUploads)
handleFileUploads
- true if they should be handledBodyHandler setBodyLimit(long bodyLimit)
-1
means no limitbodyLimit
- the max size in bytesBodyHandler setUploadsDirectory(String uploadsDirectory)
uploadsDirectory
- the uploads directoryBodyHandler setMergeFormAttributes(boolean mergeFormAttributes)
mergeFormAttributes
- true if they should be mergedBodyHandler setDeleteUploadedFilesOnEnd(boolean deleteUploadedFilesOnEnd)
deleteUploadedFilesOnEnd
- true if uploaded files should be removed after handling the requestBodyHandler setPreallocateBodyBuffer(boolean isPreallocateBodyBuffer)
isPreallocateBodyBuffer
- true
if body buffer is pre-allocated according to the size
read from content-length Header.
{code false} if body buffer is pre-allocated to 1KB, and is resized dynamicallyCopyright © 2021 Eclipse. All rights reserved.