com.sun.jersey.multipart.FormDataParam Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.jersey.multipart;
import com.sun.jersey.core.header.FormDataContentDisposition;
import com.sun.jersey.spi.container.ParamQualifier;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.FormParam;
/**
* Binds the named body part(s) of a "multipart/form-data" request
* entity body to a resource method parameter.
*
* The {@link FormParam} annotation in conjunction with the media type
* "application/x-www-form-urlencoded" is inefficient for sending and
* consuming large quantities of binary data or text containing non-ASCII
* characters.
*
* This annotation in conjunction with the media type "multipart/form-data"
* should be used for submitting and consuming forms that contain files,
* non-ASCII data, and binary data.
*
* The type T of the annotated parameter must be one of the
* following:
*
* - {@link FormDataBodyPart}. The value of the parameter will be the
* first named body part, otherwise null if such a named body part is not
* present.
*
- A
List or Collection of {@link FormDataBodyPart}.
* The value of the
* parameter will one or more named body parts with the same name, otherwise
* null if such a named body part is not present.
* - {@link FormDataContentDisposition}. The value of the parameter will be
* the content disposition of the first named body part, otherwise null if
* such a named body part is not present.
*
- A
List or Collection of {@link FormDataContentDisposition}.
* The value of
* the parameter will one or more content dispositions of the named body parts
* with the same name, otherwise null if such a named body part is not
* present.
* - A type for which a message body reader is available given the media type
* of the first named body part. The value of the parameter will be the
* result of reading using the message body reader given the type
T,
* the media type of the named part, and the bytes of the named body part as
* input.
*
* If there is no named part present and there is a default value present as
* declared by {@link DefaultValue} then the media type will be set to
* "text/plain". The value of the parameter will be the result of reading
* using the message body reader given the type T, the media type
* "text/plain", and the UTF-8 encoded bytes of the default value as input.
*
* If there is no message body reader available and the type T conforms
* to a type specified by {@link FormParam} then processing is performed
* as specified by {@link FormParam}, where the values of the form parameter
* are String instances produced by reading the bytes of the named body
* parts utilizing a message body reader for the String type and the
* media type "text/plain".
*
* If there is no named part present then processing is performed as
* specified by {@link FormParam}.
*
*
* For example, the use of this annotation allows one to support the
* following:
*
* @POST
* @Consumes(MediaType.MULTIPART_FORM_DATA_TYPE)
* public String postForm(
* @DefaultValue("true") @FormDataParam("enabled") boolean enabled,
* @FormDataParam("data") FileData bean,
* @FormDataParam("file") InputStream file,
* @FormDataParam("file") FormDataContentDisposition fileDisposition) {
* ...
* }
*
* Where the server consumes a "multipart/form-data" request entity body that
* contains one optional named body part "enabled" and two required named
* body parts "data" and "file".
*
* The optional part "enabled" is processed
* as a boolean value, if the part is absent then the
* value will be true.
*
* The part "data" is processed as a JAXB bean and contains some meta-data
* about the following part.
*
* The part "file" is a file that is uploaded, this is processed as an
* InputStream. Additional informaiton about the file from the
* "Content-Disposition" header can be accessed by the parameter
* fileDisposition.
*
*
* Note that, whilst the annotation target permits use on fields and methods,
* this annotation is only required to be supported on resource method
* parameters.
*
* @see FormDataMultiPart
* @see FormDataBodyPart
* @see FormDataContentDisposition
* @see javax.ws.rs.DefaultValue
* @see javax.ws.rs.FormParam
*/
@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@ParamQualifier
public @interface FormDataParam {
/**
* Defines the control name of a "multipart/form-data" body part whose
* content will be used to initialize the value of the annotated method
* argument.
*
* @return the control name of a "multipart/form-data" body part.
*/
String value();
}