• Home
• org.glassfish.jersey.media
• jersey-media-multipart
• 2.33
• source code
• package-info.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.glassfish.jersey.media.multipart.package-info Maven / Gradle / Ivy

/*
 * Copyright (c) 2010, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

/**
 * 
JAX-RS Integration with MIME MultiPart Message Formats
 *
 * 
The classes in this package provide for integration of
 * multipart/* request
 * and response bodies in a JAX-RS runtime environment.  The set of registered
 * providers is leveraged, in that the content type for a body part of such a
 * message reuses the same MessageBodyReader/MessageBodyWriter implementations
 * as would be used for that content type as a standalone entity.
 *
 * 
For more information on the syntax and semantics of MIME multipart streams,
 * see the following RFCs:
 * 

 * 
Multipurpose Internet Mail
 *     Extensions (MIME) Part One:  Format of Internet Message Bodies
 *     (RFC 2045)
 * 
Multipurpose Internet Mail
 *     Extensions (MIME) Part Two:  Media Types (RFC 2046)
 * 
Multipurpose Internet Mail
 *     Extensions (MIME) Part Three:  Message Header Extensions for Non-ASCII
 *     Text (RFC 2047)
 * 
Multipurpose Internet Mail
 *     Extensions (MIME) Part Four:  Registration Procedures (RFC 2048)
 * 
Multipurpose Internet Mail
 *     Extensions (MIME) Part Five:  Conformance Criteria and Examples
 *     (RFC 2049)
 * 
 *
 * 
Implementation Notes
 *
 * 
The following notes describe significant aspects of the implementation
 * of the MIME MultiPart APIs in this (and related) packages:
 * 

 * 
Although packaged as a Jersey extension, the runtime code in this
 *     library should be portable to any compliant JAX-RS implementation.
 *     Jersey is only required for execution of the unit tests.
 * 
 *
 * 
Supported MIME Multipart Capabilities
 *
 * 
The following list of general MIME MultiPart features is currently
 * supported:
 * 

 * 
The MIME-Version: 1.0 HTTP header is included on generated
 *     responses.  It is accepted, but not required, on processed requests.
 * 
A MessageBodyReader implementation for consuming MIME
 *     MultiPart entities.  See below for usage restrictions.
 * 
A MessageBodyWriter implementation for producing MIME
 *     MultiPart entities.  The appropriate Provider is used to
 *     serialize each body part, based on its media type.
 * 
Optional creation of an appropriate boundary parameter on a
 *     generated Content-Type header, if not already present.
 * 
Top level content type of multipart, with the following
 *     supported subtypes:  alternative, digest,
 *     mixed, and parallel.
 * 
 *
 * 
At present, the MessageBodyReader implementation exhibits a
 * usability issue.  It is not currently possible to know ahead of time what
 * Java class the application would prefer to use for each individual body part,
 * so an appropriate Provider cannot be selected.  Currently, the
 * unparsed content of each body part is returned (as a byte array) in the
 * entity property of the returned BodyPart} instance, and
 * the application can decide what further steps are needed based on the
 * headers included in that body part.  The simplest technique is to examine
 * the received BodyPart, and then call the getEntityAs()
 * method once you know which implementation class you would prefer.
 *
 * 
Not (Yet) Supported MIME Multipart Capabilities
 *
 * 
The following list of general MIME MultiPart features is NOT (yet, in
 * most cases) supported:
 * 

 * 
The charset parameter on the Content-Type header
 *     field.  Currently, the hard coded charset is FIXME.  [RFC2045#5.2]
 * 
The Content-Transfer-Encoding header field.  [RFC2045#6]
 * 
The message/* family of content types.
 * 
 */
package org.glassfish.jersey.media.multipart;