public class FormDataMultiPart extends MultiPart
Subclass of 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.For a client side application wishing to construct an outgoing
multipart/form-data
message, the following features
are provided:
FormDataMultiPart
instance will automatically
set to multipart/form-data
.text/plain
.FIXME - Consider supporting the use case of a nested
multipart/mixed
body part to contain multiple uploaded files.
Constructor and Description |
---|
FormDataMultiPart()
Instantiate a new
FormDataMultiPart instance with
default characteristics. |
Modifier and Type | Method and Description |
---|---|
FormDataMultiPart |
field(String name,
Object entity,
javax.ws.rs.core.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)
Get a form data body part given a control name.
|
Map<String,List<FormDataBodyPart>> |
getFields()
Get 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)
Get a list of one or more form data body parts given a control name.
|
void |
setMediaType(javax.ws.rs.core.MediaType mediaType)
Disable 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, setParent, setProviders
public FormDataMultiPart()
FormDataMultiPart
instance with
default characteristics.public FormDataMultiPart field(String name, String value)
name
- the control namevalue
- the text valuepublic FormDataMultiPart field(String name, Object entity, javax.ws.rs.core.MediaType mediaType)
name
- the control name.entity
- entity value for the new fieldmediaType
- media type for the new fieldpublic 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(javax.ws.rs.core.MediaType mediaType)
multipart/form-data
.setMediaType
in class MultiPart
mediaType
- The proposed media typeIllegalArgumentException
- if the proposed media type is not
multipart/form-data
Copyright © 2013 Oracle Corporation. All rights reserved.