nextapp.echo.filetransfer.receiver.UploadProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of echo3-filetransfer-receiver Show documentation
Echo File Transfer Receiver
The newest version!
/* 
 * This file is part of the Echo File Transfer Library.
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

package nextapp.echo.filetransfer.receiver;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;

/**
 * Service provider interface which allows pluggable selection of the library to be used to parse file uploads from
 * HttpServletRequest.
 * 
 * Custom UploadProcessor implementations may be configured by calling
 * {@link UploadProcessorFactory#setUploadProcessor(UploadProcessor)} from within an application entry point.
 */
public interface UploadProcessor {
    
    /**
     * Processes the upload of a file.
     * 
     * @param request the {@link HttpServletRequest} containing the file upload
     * @param id the unique identifier of the file upload
     * @throws IOException if an I/O error occurs during this operation
     */
    public void processUpload(HttpServletRequest request, String id) 
    throws IOException;
}