|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.sun.jersey.multipart.BodyPart
com.sun.jersey.multipart.MultiPart
com.sun.jersey.multipart.FormDataMultiPart
public class FormDataMultiPart
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 field name.Map of FormDataBodyParts
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 Summary | |
|---|---|
FormDataMultiPart()
Instantiate a new FormDataMultiPart instance with
default characteristics. |
|
| Method Summary | |
|---|---|
FormDataMultiPart |
field(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.String value)
Builder pattern method to add a named field with a text value, and return this instance. |
FormDataBodyPart |
getField(java.lang.String name)
Return the FormDataBodyPart for the specified field name,
if any; otherwise, return null. |
java.util.Map<java.lang.String,FormDataBodyPart> |
getFields()
Return an immutable Map of the FormDataBodyParts
for all fields, keyed by field name. |
void |
setMediaType(javax.ws.rs.core.MediaType mediaType)
Disable changing the media type to anything other than multipart/form-data. |
| Methods inherited from class com.sun.jersey.multipart.MultiPart |
|---|
bodyPart, bodyPart, cleanup, entity, getBodyParts, getEntity, setEntity, type |
| Methods inherited from class com.sun.jersey.multipart.BodyPart |
|---|
getEntityAs, getHeaders, getMediaType, getParameterizedHeaders, getParent, getProviders, setParent, setProviders |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FormDataMultiPart()
Instantiate a new FormDataMultiPart instance with
default characteristics.
| Method Detail |
|---|
public FormDataMultiPart field(java.lang.String name,
java.lang.String value)
Builder pattern method to add a named field with a text value, and return this instance.
public FormDataMultiPart field(java.lang.String name,
java.lang.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.
name - Field name of the new fieldentity - Entity value for the new fieldmediaType - Media type for the new fieldpublic FormDataBodyPart getField(java.lang.String name)
Return the FormDataBodyPart for the specified field name,
if any; otherwise, return null.
public java.util.Map<java.lang.String,FormDataBodyPart> getFields()
Return an immutable Map of the FormDataBodyParts
for all fields, keyed by field name.
public void setMediaType(javax.ws.rs.core.MediaType mediaType)
Disable changing the media type to anything other than
multipart/form-data.
setMediaType in class MultiPartmediaType - The proposed media type
java.lang.IllegalArgumentException - if the proposed media type is not
multipart/form-data
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||