FormDataBodyPart.java
/*
* Copyright (c) 2012, 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
*/
package org.glassfish.jersey.media.multipart;
import java.text.ParseException;
import javax.ws.rs.ProcessingException;
import javax.ws.rs.core.MediaType;
import org.glassfish.jersey.media.multipart.internal.LocalizationMessages;
import org.glassfish.jersey.message.internal.MediaTypes;
/**
* Subclass of {@link BodyPart} with specialized support for media type
* {@code multipart/form-data}. See
* <a href="http://www.ietf.org/rfc/rfc2388.txt">RFC 2388</a>
* for the formal definition of this media type.
* <p/>
* For a server side application wishing to process an incoming
* {@code multipart/form-data} message, the following features
* are provided:
* <ul>
* <li>Property accessor to retrieve the control name.</li>
* <li>Property accessor to retrieve the field value for a simple
* String field.</li>
* <li>Convenience accessor to retrieve the field value after conversion
* through an appropriate {@code MessageBodyReader}.</li>
* </ul>
* <p/>
* For a client side application wishing to construct an outgoing
* {@code multipart/form-data} message, the following features
* are provided:
* <ul>
* <li>Convenience constructors for named fields with either
* simple string values, or arbitrary entities and media types.</li>
* <li>Property accessor to set the control name.</li>
* <li>Property accessor to set the field value for a simple
* String field.</li>
* <li>Convenience accessor to set the media type and value of a
* "file" field.</li>
* </ul>
*
* @author Craig McClanahan
* @author Imran M Yousuf (imran at smartitengineering.com)
* @author Paul Sandoz
* @author Michal Gajdos
*/
public class FormDataBodyPart extends BodyPart {
private final boolean fileNameFix;
/**
* Instantiates an unnamed new {@link FormDataBodyPart} with a
* {@code mediaType} of {@code text/plain}.
*/
public FormDataBodyPart() {
this(false);
}
/**
* Instantiates an unnamed new {@link FormDataBodyPart} with {@code mediaType} of {@code 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 <a href="http://java.net/jira/browse/JERSEY-759">JERSEY-759</a>).
*
* @param fileNameFix If set to {@code true}, header parser will not treat backslash as an escape character when retrieving
* the value of {@code filename} parameter of {@code Content-Disposition} header.
*/
public FormDataBodyPart(boolean fileNameFix) {
super();
this.fileNameFix = fileNameFix;
}
/**
* Instantiates an unnamed {@link FormDataBodyPart} with the
* specified characteristics.
*
* @param mediaType the {@link MediaType} for this body part.
*/
public FormDataBodyPart(MediaType mediaType) {
super(mediaType);
this.fileNameFix = false;
}
/**
* Instantiates an unnamed {@link FormDataBodyPart} with the
* specified characteristics.
*
* @param entity the entity for this body part.
* @param mediaType the {@link MediaType} for this body part.
*/
public FormDataBodyPart(Object entity, MediaType mediaType) {
super(entity, mediaType);
this.fileNameFix = false;
}
/**
* Instantiates a named {@link FormDataBodyPart} with a
* media type of {@code text/plain} and String value.
*
* @param name the control name for this body part.
* @param value the value for this body part.
*/
public FormDataBodyPart(String name, String value) {
super(value, MediaType.TEXT_PLAIN_TYPE);
this.fileNameFix = false;
setName(name);
}
/**
* Instantiates a named {@link FormDataBodyPart} with the
* specified characteristics.
*
* @param name the control name for this body part.
* @param entity the entity for this body part.
* @param mediaType the {@link MediaType} for this body part.
*/
public FormDataBodyPart(String name, Object entity, MediaType mediaType) {
super(entity, mediaType);
this.fileNameFix = false;
setName(name);
}
/**
* Instantiates a named {@link FormDataBodyPart} with the
* specified characteristics.
*
* @param formDataContentDisposition the content disposition header for this body part.
* @param value the value for this body part.
*/
public FormDataBodyPart(FormDataContentDisposition formDataContentDisposition, String value) {
super(value, MediaType.TEXT_PLAIN_TYPE);
this.fileNameFix = false;
setFormDataContentDisposition(formDataContentDisposition);
}
/**
* Instantiates a named {@link FormDataBodyPart} with the
* specified characteristics.
*
* @param formDataContentDisposition the content disposition header for this body part.
* @param entity the entity for this body part.
* @param mediaType the {@link MediaType} for this body part.
*/
public FormDataBodyPart(FormDataContentDisposition formDataContentDisposition, Object entity, MediaType mediaType) {
super(entity, mediaType);
this.fileNameFix = false;
setFormDataContentDisposition(formDataContentDisposition);
}
/**
* Gets the form data content disposition.
*
* @return the form data content disposition.
*/
public FormDataContentDisposition getFormDataContentDisposition() {
return (FormDataContentDisposition) getContentDisposition();
}
/**
* Sets the form data content disposition.
*
* @param formDataContentDisposition the form data content disposition.
*/
public void setFormDataContentDisposition(FormDataContentDisposition formDataContentDisposition) {
super.setContentDisposition(formDataContentDisposition);
}
/**
* Overrides the behaviour on {@link BodyPart} to ensure that
* only instances of {@link FormDataContentDisposition} can be obtained.
*
* @return the content disposition.
* @throws IllegalArgumentException if the content disposition header cannot be parsed.
*/
@Override
public ContentDisposition getContentDisposition() {
if (contentDisposition == null) {
String scd = getHeaders().getFirst("Content-Disposition");
if (scd != null) {
try {
contentDisposition = new FormDataContentDisposition(scd, fileNameFix);
} catch (ParseException ex) {
throw new IllegalArgumentException(LocalizationMessages.ERROR_PARSING_CONTENT_DISPOSITION(scd), ex);
}
}
}
return contentDisposition;
}
/**
* Overrides the behaviour on {@link BodyPart} to ensure that
* only instances of {@link FormDataContentDisposition} can be set.
*
* @param contentDisposition the content disposition which must be an instance of {@link FormDataContentDisposition}.
* @throws IllegalArgumentException if the content disposition is not an instance of {@link FormDataContentDisposition}.
*/
@Override
public void setContentDisposition(ContentDisposition contentDisposition) {
if (contentDisposition instanceof FormDataContentDisposition) {
super.setContentDisposition(contentDisposition);
} else {
throw new IllegalArgumentException();
}
}
/**
* Gets the control name.
*
* @return the control name.
*/
public String getName() {
FormDataContentDisposition formDataContentDisposition = getFormDataContentDisposition();
if (formDataContentDisposition == null) {
return null;
}
return formDataContentDisposition.getName();
}
/**
* Sets the control name.
*
* @param name the control name.
*/
public void setName(String name) {
if (name == null) {
throw new IllegalArgumentException(LocalizationMessages.CONTROL_NAME_CANNOT_BE_NULL());
}
if (getFormDataContentDisposition() == null) {
FormDataContentDisposition contentDisposition;
contentDisposition = FormDataContentDisposition.name(name).build();
super.setContentDisposition(contentDisposition);
} else {
FormDataContentDisposition formDataContentDisposition = FormDataContentDisposition.name(name)
.fileName(contentDisposition.getFileName())
.creationDate(contentDisposition.getCreationDate())
.modificationDate(contentDisposition.getModificationDate())
.readDate(contentDisposition.getReadDate())
.size(contentDisposition.getSize()).build();
super.setContentDisposition(formDataContentDisposition);
}
}
/**
* Gets the field value for this body part. This should be called only on body parts representing simple field values.
*
* @return the simple field value.
* @throws ProcessingException if an IO error arises during reading the value.
* @throws IllegalStateException if called on a body part with a media type other than {@code text/plain}
*/
public String getValue() {
if (!MediaTypes.typeEqual(MediaType.TEXT_PLAIN_TYPE, getMediaType())) {
throw new IllegalStateException(LocalizationMessages.MEDIA_TYPE_NOT_TEXT_PLAIN());
}
if (getEntity() instanceof BodyPartEntity) {
return getValueAs(String.class);
} else {
return (String) getEntity();
}
}
/**
* Gets the field value after appropriate conversion to the requested type. This is useful only when the containing {@link
* FormDataMultiPart} instance has been received, which causes the {@code providers} property to have been set.
*
* @param <T> the type of the field value.
* @param clazz Desired class into which the field value should be converted.
* @return the field value.
* @throws ProcessingException if an IO error arises during reading an entity.
* @throws IllegalArgumentException if no {@code MessageBodyReader} can be found to perform the requested conversion.
* @throws IllegalStateException if this method is called when the {@code providers} property has not been set or when
* the entity instance is not the unconverted content of the body part entity.
*/
public <T> T getValueAs(Class<T> clazz) {
return getEntityAs(clazz);
}
/**
* Sets the field value for this body part. This should be called
* only on body parts representing simple field values.
*
* @param value the field value.
* @throws IllegalStateException if called on a body part with a media type other than {@code text/plain}.
*/
public void setValue(String value) {
if (!MediaType.TEXT_PLAIN_TYPE.equals(getMediaType())) {
throw new IllegalStateException(LocalizationMessages.MEDIA_TYPE_NOT_TEXT_PLAIN());
}
setEntity(value);
}
/**
* Sets the field media type and value for this body part.
*
* @param mediaType the media type for this field value.
* @param value the field value as a Java object.
*/
public void setValue(MediaType mediaType, Object value) {
setMediaType(mediaType);
setEntity(value);
}
/**
* @return {@code true} if this body part represents a simple, string-based, field value, otherwise {@code false}.
*/
public boolean isSimple() {
return MediaType.TEXT_PLAIN_TYPE.equals(getMediaType());
}
}