com.sun.jersey.multipart.file.FileDataBodyPart 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.file;
import com.sun.jersey.core.header.FormDataContentDisposition;
import com.sun.jersey.multipart.FormDataBodyPart;
import java.io.File;
import java.util.Date;
import javax.ws.rs.core.MediaType;
/**
* An extension of {@link FormDataBodyPart} for associating
* {@link File} File as a body part entity.
*
* This class may be used to create body parts that a file attachments.
* Where appropriate the Content-Disposition parameters and Content-Type header
* will be derived from the file.
*
* @author [email protected]
* @author [email protected]
*/
public class FileDataBodyPart
extends FormDataBodyPart {
private File fileEntity;
private MediaTypePredictor predictor =
DefaultMediaTypePredictor.getInstance();
/**
* 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
*/
public FileDataBodyPart() {
super();
}
/**
* Constructs the body part with the provided name and file, it predicts the
* {@link MediaType} of the file provided. For the known media types client
* will not need to set the media type explicitly.
*
* @param name The name of body part
* @param fileEntity The file that represents the entity
* @see MediaTypePredictor#getMediaTypeFromFile(java.io.File)
* @see FileDataBodyPart#FileDataBodyPart(java.lang.String, java.io.File, javax.ws.rs.core.MediaType)
*/
public FileDataBodyPart(final String name,
final File fileEntity) {
this(name, fileEntity, null);
}
/**
* Constructs the body part with all the attributes set for its proper
* function. If this constructor is used to construct the body part then it
* is not required to set any other attributes for proper behavior.
*
* @param name The name of body part
* @param fileEntity The file that represents the entity
* @param mediaType The {@link MediaType} of the body part
* @throws java.lang.IllegalArgumentException If the fileEntity is null
*/
public FileDataBodyPart(final String name,
final File fileEntity,
final MediaType mediaType)
throws IllegalArgumentException {
super();
super.setName(name);
if (mediaType != null) {
setFileEntity(fileEntity, mediaType);
} else {
setFileEntity(fileEntity, predictMediaType(fileEntity));
}
}
/**
* Get the file for this body part.
* @return File entity for this body part
*/
public File getFileEntity() {
return fileEntity;
}
/**
* This operation is not supported from this implementation.
*
* @param mediaType
* @param value
* @throws java.lang.UnsupportedOperationException Operation not supported.
* @see FileDataBodyPart#setFileEntity(java.io.File, javax.ws.rs.core.MediaType)
*/
@Override
public void setValue(MediaType mediaType,
Object value)
throws UnsupportedOperationException {
throw new UnsupportedOperationException("It is unsupported, please " +
"use setFileEntity instead!");
}
/**
* This operation is not supported from this implementation.
*
* @param entity
* @throws java.lang.UnsupportedOperationException Operation not supported.
* @see FileDataBodyPart#setFileEntity(java.io.File)
*/
@Override
public void setEntity(Object entity)
throws UnsupportedOperationException {
throw new UnsupportedOperationException("It is unsupported, please " +
"use setFileEntity instead!");
}
/**
* Sets the fileEntity for this {@link FormDataBodyPart}.
*
* @param fileEntity The entity of this {@link FormDataBodyPart}.
*/
public void setFileEntity(final File fileEntity) {
this.setFileEntity(fileEntity, predictMediaType());
}
/**
* Sets the {@link MediaType} and fileEntity for this {@link FormDataBodyPart}.
*
* @param fileEntity The entity of this body part
* @param mediaType the media type.
*/
public void setFileEntity(final File fileEntity,
final MediaType mediaType) {
super.setMediaType(mediaType);
super.setEntity(fileEntity);
this.fileEntity = fileEntity;
if (fileEntity != null) {
FormDataContentDisposition.FormDataContentDispositionBuilder builder =
FormDataContentDisposition.name(getName());
builder.fileName(fileEntity.getName());
if (fileEntity.exists()) {
builder.size(fileEntity.length());
builder.modificationDate(new Date(fileEntity.lastModified()));
}
setFormDataContentDisposition(builder.build());
}
}
/**
* Predict the media type of the current fileEntity.
*
* @return Predicted {@link MediaType}
*/
protected MediaType predictMediaType() {
return predictMediaType(getFileEntity());
}
/**
* Predict the media type of the provided {@link File}.
*
* @param file the file from which the media type is predicted.
* @return Predicted {@link MediaType}
*/
protected MediaType predictMediaType(final File file) {
return getPredictor().getMediaTypeFromFile(file);
}
/**
* Get the media type predictor.
*
* @return the media type predictor.
*/
public MediaTypePredictor getPredictor() {
return predictor;
}
/**
* Set the media type predictor.
*
* @param predictor the media type predictor.
*/
public void setPredictor(MediaTypePredictor predictor) {
if (predictor == null) {
throw new IllegalArgumentException();
}
this.predictor = predictor;
}
}