I_CmsUploadService.java

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ade.upload.shared.rpc;

import org.opencms.ade.upload.shared.CmsUploadData;
import org.opencms.ade.upload.shared.CmsUploadFileBean;
import org.opencms.ade.upload.shared.CmsUploadProgessInfo;
import org.opencms.gwt.CmsRpcException;

import java.util.List;

import com.google.gwt.user.client.rpc.RemoteService;

/**
 * Handles all RPC services related to the upload dialog.<p>
 * 
 * @since 8.0.0
 * 
 * @see org.opencms.ade.upload.CmsUploadService
 * @see org.opencms.ade.upload.shared.rpc.I_CmsUploadService
 * @see org.opencms.ade.upload.shared.rpc.I_CmsUploadServiceAsync
 */
public interface I_CmsUploadService extends RemoteService {

    /**
     * Generates upload data for prefetching in the host page.<p>
     * 
     * @return the upload data
     * 
     * @throws CmsRpcException if something goes wrong 
     */
    CmsUploadData prefetch() throws CmsRpcException;

    /**
     * Cancels the upload.<p>
     * 
     * @return <code>true</code> if the listener was canceled <code>false</code> otherwise
     */
    Boolean cancelUpload();

    /**
     * Checks the availability of a resource in the VFS, using the 
     * {@link org.opencms.file.CmsResourceFilter#IGNORE_EXPIRATION} filter.<p>
     * 
     * Calculates the VFS path for each filename in the given list and checks its availability.<p>
     * 
     * @param fileNames the filenames to check
     * @param targetFolder the folder to check
     * 
     * @return a {@link CmsUploadFileBean} that holds the list of resource names (without the path) 
     * that already exist in the VFS and a list of filenames that are invalid
     */
    CmsUploadFileBean checkUploadFiles(List<String> fileNames, String targetFolder);

    /**
     * Returns the upload progress information.<p>
     * 
     * @return the upload progress information
     * 
     * @throws CmsRpcException if something goes wrong 
     */
    CmsUploadProgessInfo getUploadProgressInfo() throws CmsRpcException;
}