public class FormDataBodyPart extends BodyPart
Subclass of BodyPart
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:
MessageBodyReader
.For a client side application wishing to construct an outgoing
multipart/form-data
message, the following features
are provided:
Constructor and Description |
---|
FormDataBodyPart()
|
FormDataBodyPart(boolean fileNameFix)
Instantiate an unnamed new
FormDataBodyPart with mediaType of text/plain
and setting the flag for applying the fix for erroneous file name value if content disposition header of
messages coming from MS Internet Explorer (see JERSEY-759). |
FormDataBodyPart(FormDataContentDisposition fdcd,
Object entity,
javax.ws.rs.core.MediaType mediaType)
Instantiate a named
FormDataBodyPart with the
specified characteristics. |
FormDataBodyPart(FormDataContentDisposition fdcd,
String value)
Instantiate a named
FormDataBodyPart with the
specified characteristics. |
FormDataBodyPart(javax.ws.rs.core.MediaType mediaType)
Instantiate an unnamed
FormDataBodyPart with the
specified characteristics. |
FormDataBodyPart(Object entity,
javax.ws.rs.core.MediaType mediaType)
Instantiate an unnamed
FormDataBodyPart with the
specified characteristics. |
FormDataBodyPart(String name,
Object entity,
javax.ws.rs.core.MediaType mediaType)
Instantiate a named
FormDataBodyPart with the
specified characteristics. |
FormDataBodyPart(String name,
String value)
Instantiate a named
FormDataBodyPart with a
media type of text/plain and String value. |
Modifier and Type | Method and Description |
---|---|
ContentDisposition |
getContentDisposition()
Override the behaviour on
BodyPart to ensure that
only instances of FormDataContentDisposition can be obtained. |
FormDataContentDisposition |
getFormDataContentDisposition()
Get the form data content disposition.
|
String |
getName()
Get the control name.
|
String |
getValue()
Get the field value for this body part.
|
<T> T |
getValueAs(Class<T> clazz)
Get the field value after appropriate conversion to the requested
type.
|
boolean |
isSimple() |
void |
setContentDisposition(ContentDisposition cd)
Override the behaviour on
BodyPart to ensure that
only instances of FormDataContentDisposition can be set. |
void |
setFormDataContentDisposition(FormDataContentDisposition cd)
Set the form data content disposition.
|
void |
setName(String name)
Set the control name.
|
void |
setValue(javax.ws.rs.core.MediaType mediaType,
Object value)
Set the field media type and value for this body part.
|
void |
setValue(String value)
Set the field value for this body part.
|
cleanup, contentDisposition, entity, getEntity, getEntityAs, getHeaders, getMediaType, getParameterizedHeaders, getParent, getProviders, setEntity, setMediaType, setParent, setProviders, type
public FormDataBodyPart()
public FormDataBodyPart(boolean fileNameFix)
FormDataBodyPart
with mediaType
of text/plain
and setting the flag for applying the fix for erroneous file name value if content disposition header of
messages coming from MS Internet Explorer (see JERSEY-759).fileNameFix
- If set to true
, header parser will not treat backslash as an escape character
when retrieving the value of filename
parameter of
Content-Disposition
header.public FormDataBodyPart(javax.ws.rs.core.MediaType mediaType)
FormDataBodyPart
with the
specified characteristics.mediaType
- The MediaType
for this body partpublic FormDataBodyPart(Object entity, javax.ws.rs.core.MediaType mediaType)
FormDataBodyPart
with the
specified characteristics.entity
- The entity for this body partmediaType
- The MediaType
for this body partpublic FormDataBodyPart(String name, String value)
FormDataBodyPart
with a
media type of text/plain
and String value.name
- the control name for this body partvalue
- the value for this body partpublic FormDataBodyPart(String name, Object entity, javax.ws.rs.core.MediaType mediaType)
FormDataBodyPart
with the
specified characteristics.name
- the control name for this body partentity
- the entity for this body partmediaType
- the MediaType
for this body partpublic FormDataBodyPart(FormDataContentDisposition fdcd, String value)
FormDataBodyPart
with the
specified characteristics.fdcd
- the content disposition header for this body part.value
- the value for this body partpublic FormDataBodyPart(FormDataContentDisposition fdcd, Object entity, javax.ws.rs.core.MediaType mediaType)
FormDataBodyPart
with the
specified characteristics.fdcd
- the content disposition header for this body part.entity
- The entity for this body partmediaType
- The MediaType
for this body partpublic FormDataContentDisposition getFormDataContentDisposition()
public void setFormDataContentDisposition(FormDataContentDisposition cd)
cd
- the form data content disposition.public ContentDisposition getContentDisposition()
BodyPart
to ensure that
only instances of FormDataContentDisposition
can be obtained.getContentDisposition
in class BodyPart
IllegalArgumentException
- if the content disposition header
cannot be parsed.public void setContentDisposition(ContentDisposition cd)
BodyPart
to ensure that
only instances of FormDataContentDisposition
can be set.setContentDisposition
in class BodyPart
cd
- the content disposition which must be an instance
of FormDataContentDisposition
.IllegalArgumentException
- if the content disposition is not an
instance of FormDataContentDisposition
.public String getName()
public void setName(String name)
name
- the control name.public String getValue()
IllegalStateException
- if called on a body part with a
media type other than text/plain
public <T> T getValueAs(Class<T> clazz)
FormDataMultiPart
instance has been received, which causes the providers
property to have been set.T
- the type of the field value.clazz
- Desired class into which the field value should be convertedIllegalArgumentException
- if no MessageBodyReader
can
be found to perform the requested conversionIllegalStateException
- if this method is called when the
providers
property has not been set or when the
entity instance is not the unconverted content of the body part
entitypublic void setValue(String value)
value
- the field valueIllegalStateException
- if called on a body part with a
media type other than text/plain
public void setValue(javax.ws.rs.core.MediaType mediaType, Object value)
mediaType
- the media type for this field valuevalue
- the field value as a Java objectpublic boolean isSimple()
Copyright © 2013 Oracle Corporation. All rights reserved.