public class FileDataBodyPart extends FormDataBodyPart
FormDataBodyPart
for associating
File
File as a body part entity.
This class may be used to create body parts that contains a file attachments.
Appropriate Content-Disposition parameters and Content-Type header will be derived from the file.contentDisposition, messageBodyWorkers
Constructor and Description |
---|
FileDataBodyPart()
A no-args constructor which expects its client to set the values
individually, the attributes to be set are fileEntity and name; the
media type will be predicted from the fileEntity if not set explicitly.
|
FileDataBodyPart(String name,
File fileEntity)
Constructs the body part with the provided name and file, it predicts the
MediaType of the file provided. |
FileDataBodyPart(String name,
File fileEntity,
MediaType mediaType)
Constructs the body part with all the attributes set for its proper
function.
|
Modifier and Type | Method and Description |
---|---|
File |
getFileEntity()
Gets the file for this body part.
|
MediaTypePredictor |
getPredictor()
Gets the media type predictor.
|
protected MediaType |
predictMediaType()
Predicts the media type of the current fileEntity.
|
protected MediaType |
predictMediaType(File file)
Predicts the media type of the provided
File . |
void |
setEntity(Object entity)
This operation is not supported from this implementation.
|
void |
setFileEntity(File fileEntity)
Sets the fileEntity for this
FormDataBodyPart . |
void |
setFileEntity(File fileEntity,
MediaType mediaType)
Sets the
MediaType and fileEntity for this FormDataBodyPart . |
void |
setPredictor(MediaTypePredictor predictor)
Sets the media type predictor.
|
void |
setValue(MediaType mediaType,
Object value)
This operation is not supported from this implementation.
|
getContentDisposition, getFormDataContentDisposition, getName, getValue, getValueAs, isSimple, setContentDisposition, setFormDataContentDisposition, setName, setValue
cleanup, contentDisposition, entity, getEntity, getEntityAs, getHeaders, getMediaType, getParameterizedHeaders, getParent, getProviders, setMediaType, setMessageBodyWorkers, setParent, setProviders, type
public FileDataBodyPart()
public FileDataBodyPart(String name, File fileEntity)
MediaType
of the file provided. For the known media types client
will not need to set the media type explicitly.name
- the name of body part.fileEntity
- the file that represents the entity.MediaTypePredictor.getMediaTypeFromFile(java.io.File)
,
FileDataBodyPart(java.lang.String, java.io.File, jakarta.ws.rs.core.MediaType)
public FileDataBodyPart(String name, File fileEntity, MediaType mediaType) throws IllegalArgumentException
name
- the name of body part.fileEntity
- the file that represents the entity.mediaType
- the MediaType
of the body part.IllegalArgumentException
- if the fileEntity is null
.public File getFileEntity()
public void setValue(MediaType mediaType, Object value) throws UnsupportedOperationException
setValue
in class FormDataBodyPart
mediaType
- the media type for this field value.value
- the field value as a Java object.UnsupportedOperationException
- Operation not supported.setFileEntity(java.io.File, jakarta.ws.rs.core.MediaType)
public void setEntity(Object entity) throws UnsupportedOperationException
setEntity
in class BodyPart
entity
- the new entity object.UnsupportedOperationException
- Operation not supported.setFileEntity(java.io.File)
public void setFileEntity(File fileEntity)
FormDataBodyPart
.fileEntity
- the entity of this FormDataBodyPart
.public void setFileEntity(File fileEntity, MediaType mediaType)
MediaType
and fileEntity for this FormDataBodyPart
.fileEntity
- the entity of this body part.mediaType
- the media type.protected MediaType predictMediaType()
MediaType
.protected MediaType predictMediaType(File file)
File
.file
- the file from which the media type is predicted.MediaType
.public MediaTypePredictor getPredictor()
public void setPredictor(MediaTypePredictor predictor)
predictor
- the media type predictor.Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.