A

addBoundary(MediaType) - Static method in class com.sun.jersey.multipart.Boundary

Transform a media type and add a boundary parameter with a unique value if one is not already present.

B

BodyPart - Class in com.sun.jersey.multipart

A mutable model representing a body part nested inside a MIME MultiPart entity.

BodyPart() - Constructor for class com.sun.jersey.multipart.BodyPart

Instantiate a new BodyPart with a mediaType of text/plain.

BodyPart(MediaType) - Constructor for class com.sun.jersey.multipart.BodyPart

Instantiate a new BodyPart with the specified characteristics.

BodyPart(Object, MediaType) - Constructor for class com.sun.jersey.multipart.BodyPart

Instantiate a new BodyPart with the specified characteristics.

bodyPart(BodyPart) - Method in class com.sun.jersey.multipart.MultiPart

Builder pattern method to add the specified BodyPart to this MultiPart.

bodyPart(Object, MediaType) - Method in class com.sun.jersey.multipart.MultiPart

Builder pattern method to add a newly configured BodyPart to this MultiPart.

BodyPartEntity - Class in com.sun.jersey.multipart

Proxy class representing the entity of a BodyPart when a MultiPart entity is received and parsed.

BodyPartEntity(MIMEPart) - Constructor for class com.sun.jersey.multipart.BodyPartEntity

Construct a new BodyPartEntity with a MIMEPart.

Boundary - Class in com.sun.jersey.multipart

Utility for creating boundary parameters.

Boundary() - Constructor for class com.sun.jersey.multipart.Boundary

 

BOUNDARY_PARAMETER - Static variable in class com.sun.jersey.multipart.Boundary

 

BUFFER_THRESHOLD_NAME - Static variable in class com.sun.jersey.multipart.MultiPartConfig

Name of the resource property for the bufferThreshold property.

C

cd - Variable in class com.sun.jersey.multipart.BodyPart

 

cleanup() - Method in class com.sun.jersey.multipart.BodyPart

Perform any necessary cleanup at the end of processing this BodyPart.

cleanup() - Method in class com.sun.jersey.multipart.BodyPartEntity

Clean up temporary file(s), if any were utilized.

cleanup() - Method in class com.sun.jersey.multipart.MultiPart

Perform any necessary cleanup at the end of processing this MultiPart.

close() - Method in class com.sun.jersey.multipart.BodyPartEntity

Defer to BodyPartEntity.cleanup().

close() - Method in class com.sun.jersey.multipart.MultiPart

 

com.sun.jersey.multipart - package com.sun.jersey.multipart

JAX-RS Integration with MIME MultiPart Message Formats

com.sun.jersey.multipart.file - package com.sun.jersey.multipart.file

Provides support for body parts that are file attachments.

contentDisposition(ContentDisposition) - Method in class com.sun.jersey.multipart.BodyPart

 

createAlternative() - Static method in class com.sun.jersey.multipart.MultiPartMediaTypes

 

createBoundary() - Static method in class com.sun.jersey.multipart.Boundary

Create a unique boundary.

createDigest() - Static method in class com.sun.jersey.multipart.MultiPartMediaTypes

 

createFormData() - Static method in class com.sun.jersey.multipart.MultiPartMediaTypes

 

createMixed() - Static method in class com.sun.jersey.multipart.MultiPartMediaTypes

 

createParallel() - Static method in class com.sun.jersey.multipart.MultiPartMediaTypes

 

D

DefaultMediaTypePredictor - Class in com.sun.jersey.multipart.file

Default implementation of MediaTypePredictor that uses DefaultMediaTypePredictor.CommonMediaTypes.

DefaultMediaTypePredictor() - Constructor for class com.sun.jersey.multipart.file.DefaultMediaTypePredictor

 

DefaultMediaTypePredictor.CommonMediaTypes - Enum in com.sun.jersey.multipart.file

This enum represents file extension and MIME types of commonly used file.

E

entity(Object) - Method in class com.sun.jersey.multipart.BodyPart

Builder pattern method to return this BodyPart after additional configuration.

entity(Object) - Method in class com.sun.jersey.multipart.MultiPart

Override the entity set operation on a MultiPart to throw IllegalArgumentException.

F

field(String, String) - Method in class com.sun.jersey.multipart.FormDataMultiPart

Builder pattern method to add a named field with a text value, and return this instance.

field(String, Object, MediaType) - Method in class com.sun.jersey.multipart.FormDataMultiPart

Builder pattern method to add a named field with an arbitrary media type and entity, and return this instance.

FileDataBodyPart - Class in com.sun.jersey.multipart.file

An extension of FormDataBodyPart for associating File File as a body part entity.

FileDataBodyPart() - Constructor for class com.sun.jersey.multipart.file.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, File) - Constructor for class com.sun.jersey.multipart.file.FileDataBodyPart

Constructs the body part with the provided name and file, it predicts the MediaType of the file provided.

FileDataBodyPart(String, File, MediaType) - Constructor for class com.sun.jersey.multipart.file.FileDataBodyPart

Constructs the body part with all the attributes set for its proper function.

FormDataBodyPart - Class in com.sun.jersey.multipart

Subclass of BodyPart with specialized support for media type multipart/form-data.

FormDataBodyPart() - Constructor for class com.sun.jersey.multipart.FormDataBodyPart

FormDataBodyPart with a mediaType of text/plain.

FormDataBodyPart(MediaType) - Constructor for class com.sun.jersey.multipart.FormDataBodyPart

Instantiate an unnamed FormDataBodyPart with the specified characteristics.

FormDataBodyPart(Object, MediaType) - Constructor for class com.sun.jersey.multipart.FormDataBodyPart

Instantiate an unnamed FormDataBodyPart with the specified characteristics.

FormDataBodyPart(String, String) - Constructor for class com.sun.jersey.multipart.FormDataBodyPart

Instantiate a named FormDataBodyPart with a media type of text/plain and String value.

FormDataBodyPart(String, Object, MediaType) - Constructor for class com.sun.jersey.multipart.FormDataBodyPart

Instantiate a named FormDataBodyPart with the specified characteristics.

FormDataBodyPart(FormDataContentDisposition, String) - Constructor for class com.sun.jersey.multipart.FormDataBodyPart

Instantiate a named FormDataBodyPart with the specified characteristics.

FormDataBodyPart(FormDataContentDisposition, Object, MediaType) - Constructor for class com.sun.jersey.multipart.FormDataBodyPart

Instantiate a named FormDataBodyPart with the specified characteristics.

FormDataMultiPart - Class in com.sun.jersey.multipart

Subclass of MultiPart with specialized support for media type multipart/form-data.

FormDataMultiPart() - Constructor for class com.sun.jersey.multipart.FormDataMultiPart

Instantiate a new FormDataMultiPart instance with default characteristics.

FormDataParam - Annotation Type in com.sun.jersey.multipart

Binds the named body part(s) of a "multipart/form-data" request entity body to a resource method parameter.

G

getBodyParts() - Method in class com.sun.jersey.multipart.MultiPart

Return a mutable list of BodyParts nested in this MultiPart.

getBufferThreshold() - Method in class com.sun.jersey.multipart.MultiPartConfig

Return the size (in bytes) of the entity of an incoming BodyPart before it will be buffered to disk.

getContentDisposition() - Method in class com.sun.jersey.multipart.BodyPart

Get the content disposition.

getContentDisposition() - Method in class com.sun.jersey.multipart.FormDataBodyPart

Override the behaviour on BodyPart to ensure that only instances of FormDataContentDisposition can be obtained.

getEntity() - Method in class com.sun.jersey.multipart.BodyPart

Return the entity object to be unmarshalled from a request, or to be marshalled on a response.

getEntity() - Method in class com.sun.jersey.multipart.MultiPart

Disable access to the entity for a MultiPart.

getEntityAs(Class<T>) - Method in class com.sun.jersey.multipart.BodyPart

Return the entity after appropriate conversion to the requested type.

getExtension() - Method in enum com.sun.jersey.multipart.file.DefaultMediaTypePredictor.CommonMediaTypes

Get the file extension.

getField(String) - Method in class com.sun.jersey.multipart.FormDataMultiPart

Get a form data body part given a control name.

getFields(String) - Method in class com.sun.jersey.multipart.FormDataMultiPart

Get a list of one or more form data body parts given a control name.

getFields() - Method in class com.sun.jersey.multipart.FormDataMultiPart

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.

getFileEntity() - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

Get the file for this body part.

getFormDataContentDisposition() - Method in class com.sun.jersey.multipart.FormDataBodyPart

Get the form data content disposition.

getHeaders() - Method in class com.sun.jersey.multipart.BodyPart

Return a mutable map of HTTP header value(s) for this BodyPart, keyed by the header name.

getInputStream() - Method in class com.sun.jersey.multipart.BodyPartEntity

Get the input stream to the raw bytes of this body part entity.

getInstance() - Static method in class com.sun.jersey.multipart.file.DefaultMediaTypePredictor

Get the singleton instance of this class.

getMediaType() - Method in class com.sun.jersey.multipart.BodyPart

Return the MediaType for this BodyPart.

getMediaType() - Method in enum com.sun.jersey.multipart.file.DefaultMediaTypePredictor.CommonMediaTypes

Get the media type.

getMediaTypeFromFile(File) - Static method in enum com.sun.jersey.multipart.file.DefaultMediaTypePredictor.CommonMediaTypes

A utility method for predicting media type from a file name.

getMediaTypeFromFile(File) - Method in class com.sun.jersey.multipart.file.DefaultMediaTypePredictor

 

getMediaTypeFromFile(File) - Method in interface com.sun.jersey.multipart.file.MediaTypePredictor

Get the media type from a file name.

getMediaTypeFromFileName(String) - Static method in enum com.sun.jersey.multipart.file.DefaultMediaTypePredictor.CommonMediaTypes

A utility method for predicting media type from a file name.

getMediaTypeFromFileName(String) - Method in class com.sun.jersey.multipart.file.DefaultMediaTypePredictor

 

getMediaTypeFromFileName(String) - Method in interface com.sun.jersey.multipart.file.MediaTypePredictor

Get the media type from a file name.

getName() - Method in class com.sun.jersey.multipart.FormDataBodyPart

Get the control name.

getParameterizedHeaders() - Method in class com.sun.jersey.multipart.BodyPart

Return an immutable map of parameterized HTTP header value(s) for this BodyPart, keyed by header name.

getParent() - Method in class com.sun.jersey.multipart.BodyPart

Return the parent MultiPart (if any) for this BodyPart.

getPredictor() - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

Get the media type predictor.

getProviders() - Method in class com.sun.jersey.multipart.BodyPart

Return the configured Providers for this BodyPart.

getValue() - Method in class com.sun.jersey.multipart.FormDataBodyPart

Get the field value for this body part.

getValueAs(Class<T>) - Method in class com.sun.jersey.multipart.FormDataBodyPart

Get the field value after appropriate conversion to the requested type.

I

isSimple() - Method in class com.sun.jersey.multipart.FormDataBodyPart

 

M

MediaTypePredictor - Interface in com.sun.jersey.multipart.file

An interface which allows developers implement their own media type predictor.

MULTI_PART_CONFIG_RESOURCE - Static variable in class com.sun.jersey.multipart.MultiPartConfig

Name of a properties resource that (if found in the classpath for this application) will be used to configure the settings returned by our getter methods.

MultiPart - Class in com.sun.jersey.multipart

A mutable model representing a MIME MultiPart entity.

MultiPart() - Constructor for class com.sun.jersey.multipart.MultiPart

Instantiate a new MultiPart with a mediaType of multipart/mixed.

MultiPart(MediaType) - Constructor for class com.sun.jersey.multipart.MultiPart

Instantiate a new MultiPart with the specified characteristics.

MULTIPART_ALTERNATIVE - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/alternative"

MULTIPART_ALTERNATIVE_TYPE - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/alternative"

MULTIPART_DIGEST - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/digest"

MULTIPART_DIGEST_TYPE - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/digest"

MULTIPART_MIXED - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/mixed"

MULTIPART_MIXED_TYPE - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/mixed"

MULTIPART_PARALLEL - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/parallel"

MULTIPART_PARELLEL_TYPE - Static variable in class com.sun.jersey.multipart.MultiPartMediaTypes

"multipart/parallel"

MultiPartConfig - Class in com.sun.jersey.multipart

Injectable JavaBean containing the configuration parameters for jersey-multipart as used in this particular application.

MultiPartConfig() - Constructor for class com.sun.jersey.multipart.MultiPartConfig

Load and customize (if necessary) the configuration values for the jersey-multipart module.

MultiPartMediaTypes - Class in com.sun.jersey.multipart

Convenience MediaType (and associated String) manifest constants.

MultiPartMediaTypes() - Constructor for class com.sun.jersey.multipart.MultiPartMediaTypes

 

P

predictMediaType() - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

Predict the media type of the current fileEntity.

predictMediaType(File) - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

Predict the media type of the provided File.

S

setContentDisposition(ContentDisposition) - Method in class com.sun.jersey.multipart.BodyPart

Set the content disposition.

setContentDisposition(ContentDisposition) - Method in class com.sun.jersey.multipart.FormDataBodyPart

Override the behaviour on BodyPart to ensure that only instances of FormDataContentDisposition can be set.

setEntity(Object) - Method in class com.sun.jersey.multipart.BodyPart

Set the entity object to be unmarshalled from a request, or to be marshalled on a response.

setEntity(Object) - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

This operation is not supported from this implementation.

setEntity(Object) - Method in class com.sun.jersey.multipart.MultiPart

Disable access to the entity for a MultiPart.

setFileEntity(File) - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

Sets the fileEntity for this FormDataBodyPart.

setFileEntity(File, MediaType) - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

Sets the MediaType and fileEntity for this FormDataBodyPart.

setFormDataContentDisposition(FormDataContentDisposition) - Method in class com.sun.jersey.multipart.FormDataBodyPart

Set the form data content disposition.

setMediaType(MediaType) - Method in class com.sun.jersey.multipart.BodyPart

Set the MediaType for this BodyPart.

setMediaType(MediaType) - Method in class com.sun.jersey.multipart.FormDataMultiPart

Disable changing the media type to anything other than multipart/form-data.

setMediaType(MediaType) - Method in class com.sun.jersey.multipart.MultiPart

Set the MediaType for this MultiPart.

setName(String) - Method in class com.sun.jersey.multipart.FormDataBodyPart

Set the control name.

setParent(MultiPart) - Method in class com.sun.jersey.multipart.BodyPart

Set the parent MultiPart (if any) for this BodyPart.

setPredictor(MediaTypePredictor) - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

Set the media type predictor.

setProviders(Providers) - Method in class com.sun.jersey.multipart.BodyPart

Set the configured Providers for this BodyPart.

setValue(MediaType, Object) - Method in class com.sun.jersey.multipart.file.FileDataBodyPart

This operation is not supported from this implementation.

setValue(String) - Method in class com.sun.jersey.multipart.FormDataBodyPart

Set the field value for this body part.

setValue(MediaType, Object) - Method in class com.sun.jersey.multipart.FormDataBodyPart

Set the field media type and value for this body part.

T

type(MediaType) - Method in class com.sun.jersey.multipart.BodyPart

Builder pattern method to return this BodyPart after additional configuration.

type(MediaType) - Method in class com.sun.jersey.multipart.MultiPart

Builder pattern method to return this MultiPart after additional configuration.

V

valueOf(String) - Static method in enum com.sun.jersey.multipart.file.DefaultMediaTypePredictor.CommonMediaTypes

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.sun.jersey.multipart.file.DefaultMediaTypePredictor.CommonMediaTypes

Returns an array containing the constants of this enum type, in the order they are declared.