atom.ws.rs.AbstractUploadService Maven / Gradle / Ivy
/*
* Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Geeoz Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Geeoz Software is supplied to you by Geeoz in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Geeoz Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Geeoz Software.
*
* Neither the name, trademarks, service marks or logos of Geeoz may be used
* to endorse or promote products derived from the Geeoz Software without
* specific prior written permission from Geeoz.
*
* The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.geeoz.com/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Geeoz and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Geeoz and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Geeoz or visit www.geeoz.com if you need additional
* information or have any questions.
*/
package atom.ws.rs;
import atom.app.ActivityThread;
import atom.ws.model.ClientRequestContext;
import atom.ws.model.ContextService;
import org.glassfish.jersey.media.multipart.FormDataBodyPart;
import org.glassfish.jersey.media.multipart.FormDataParam;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.Response;
import java.util.List;
import java.util.Locale;
/**
* REST service definition responsible to files processing uploaded via upload
* view.
*
* Implementation should take care of file saving and their accessibility.
*
* @author Serge Voloshyn
* @author Vladimir Ovcharov
* @version 1.6 3/1/15
*/
public abstract class AbstractUploadService {
/**
* Content-Disposition header value prefix.
*/
static final String CONTENT_DISPOSITION_PREFIX = "attachment;filename=";
/**
* Default mime-type for content streaming.
*/
static final String DEFAULT_MIME_TYPE = MediaType.APPLICATION_OCTET_STREAM;
/**
* Save file into the permanent storage that can be access by the client
* request.
*
* @param request current REST request
* @param thread current user activity thread
* @param files uploaded by user files
* @param src params
* @return store result
*/
protected abstract Response save(final Request request,
final ActivityThread thread,
final List files,
final String src);
/**
* Find a file that was previously stored from the content editor.
*
* @param request current REST request
* @param thread current user activity thread
* @param id file identifier
* @return file content data wrapped with response
*/
protected abstract Response find(final Request request,
final ActivityThread thread,
final String id);
/**
* Upload binary data to server.
*
* @param request current REST request
* @param httpRequest current http request
* @param files uploaded files
* @param src params
* @return simple response with uploading state.
*/
@POST
@Path("/upload")
@Consumes(MediaType.MULTIPART_FORM_DATA)
public final Response uploadBinary(
@Context final Request request,
@Context final HttpServletRequest httpRequest,
@FormDataParam("files[]") final List files,
@FormDataParam("src") final String src) {
final ActivityThread thread
= ContextService.getActivityThread("",
ClientRequestContext.create(httpRequest.getSession(true),
Locale.getDefault(),
httpRequest.getCookies()));
return save(request, thread, files, src);
}
/**
* Find binary data.
*
* @param request current REST request
* @param httpRequest current http request
* @param id binary identifier
* @return simple response with uploading state.
*/
@GET
@Path("/get/{id:.+}")
public final Response get(@Context final Request request,
@Context final HttpServletRequest httpRequest,
@PathParam("id") final String id) {
final ActivityThread thread
= ContextService.getActivityThread("",
ClientRequestContext.create(httpRequest.getSession(true),
Locale.getDefault(),
httpRequest.getCookies()));
return find(request, thread, id);
}
/**
* Retrieve file's name from the body part of multiform request.
*
* @param bodyPart multiform body part containing file
* @return uploaded file's name
*/
static String getFileName(final FormDataBodyPart bodyPart) {
return bodyPart.getContentDisposition().getFileName();
}
}