public class FormDataMultiPart extends MultiPart
MultiPart
with specialized support for media type multipart/form-data
. See
RFC 2388 for the formal definition of this media type.
For a server side application wishing to process an incoming multipart/form-data
message, the following features
are provided:
FormDataMultiPart
, enabling access to the specialized methods.FormDataBodyPart
, enabling access to its specialized methods.FormDataBodyPart
for a specified control name.Map
of FormDataBodyPart
s for all fields, keyed by field name.multipart/form-data
message, the following features
are provided:
FormDataMultiPart
instance will automatically set to multipart/form-data
.text/plain
.multipart/mixed
body part to contain multiple uploaded files.contentDisposition, messageBodyWorkers
Constructor and Description |
---|
FormDataMultiPart()
Instantiates a new
FormDataMultiPart instance with
default characteristics. |
Modifier and Type | Method and Description |
---|---|
FormDataMultiPart |
field(String name,
Object entity,
MediaType mediaType)
Builder pattern method to add a named field with an arbitrary
media type and entity, and return this instance.
|
FormDataMultiPart |
field(String name,
String value)
Builder pattern method to add a named field with a text value,
and return this instance.
|
FormDataBodyPart |
getField(String name)
Gets a form data body part given a control name.
|
Map<String,List<FormDataBodyPart>> |
getFields()
Gets a map of form data body parts where the key is the control name
and the value is a list of one or more form data body parts.
|
List<FormDataBodyPart> |
getFields(String name)
Gets a list of one or more form data body parts given a control name.
|
void |
setMediaType(MediaType mediaType)
Disables changing the media type to anything other than
multipart/form-data . |
bodyPart, bodyPart, cleanup, close, entity, getBodyParts, getEntity, setEntity, type
contentDisposition, getContentDisposition, getEntityAs, getHeaders, getMediaType, getParameterizedHeaders, getParent, getProviders, setContentDisposition, setMessageBodyWorkers, setParent, setProviders
public FormDataMultiPart()
FormDataMultiPart
instance with
default characteristics.public FormDataMultiPart field(String name, String value)
name
- the control name.value
- the text value.public FormDataMultiPart field(String name, Object entity, MediaType mediaType)
name
- the control name.entity
- entity value for the new field.mediaType
- media type for the new field.public FormDataBodyPart getField(String name)
name
- the control name.public List<FormDataBodyPart> getFields(String name)
name
- the control name.public Map<String,List<FormDataBodyPart>> getFields()
public void setMediaType(MediaType mediaType)
multipart/form-data
.setMediaType
in class MultiPart
mediaType
- the proposed media type.IllegalArgumentException
- if the proposed media type is not multipart/form-data
.Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.