org.opencms.gwt.shared.rpc.I_CmsUploadService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (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.gwt.shared.rpc;

import org.opencms.gwt.CmsRpcException;
import org.opencms.gwt.shared.CmsUploadFileBean;
import org.opencms.gwt.shared.CmsUploadProgessInfo;

import java.util.List;

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

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

    /**
     * Cancels the upload.

     *
     * @return true if the listener was canceled false otherwise
     */
    Boolean cancelUpload();

    /**
     * Checks the availability of a resource in the VFS, using the
     * {@link org.opencms.file.CmsResourceFilter#IGNORE_EXPIRATION} filter.

     *
     * Calculates the VFS path for each filename in the given list and checks its availability.

     *
     * @param fileNames the filenames to check
     * @param targetFolder the folder to check
     * @param isRootPath true in case the target folder path is a root path
     *
     * @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 fileNames, String targetFolder, boolean isRootPath);

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