org.opencms.ade.upload
Class CmsUploadService

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
              com.google.gwt.user.server.rpc.RemoteServiceServlet
                  org.opencms.gwt.CmsGwtService
                      org.opencms.ade.upload.CmsUploadService

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, I_CmsUploadService

public class CmsUploadService
extends CmsGwtService
implements I_CmsUploadService

Handles all RPC services related to the upload dialog.

Since:

8.0.0

See Also:

CmsUploadService, I_CmsUploadService, I_CmsUploadServiceAsync, Serialized Form

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Constructor Summary

CmsUploadService()

Method Summary

Boolean	cancelUpload() Cancels the upload.
CmsUploadFileBean	checkUploadFiles(List<String> fileNames, String targetFolder) Checks the availability of a resource in the VFS, using the CmsResourceFilter.IGNORE_EXPIRATION filter.
CmsUploadProgessInfo	getUploadProgressInfo() Returns the upload progress information.
static CmsUploadService	newInstance(javax.servlet.http.HttpServletRequest request) Returns a new configured service instance.
CmsUploadData	prefetch() Generates upload data for prefetching in the host page.

Methods inherited from class org.opencms.gwt.CmsGwtService

checkPermissions, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, log, log, logError, service, setCms, setContext, setRequest, tryUnlock

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsUploadService

public CmsUploadService()

Method Detail

newInstance

public static CmsUploadService newInstance(javax.servlet.http.HttpServletRequest request)

Returns a new configured service instance.

Parameters:

request - the current request

Returns:

a new service instance

cancelUpload

public Boolean cancelUpload()

Description copied from interface: I_CmsUploadService

Cancels the upload.

Specified by:

cancelUpload in interface I_CmsUploadService

Returns:

true if the listener was canceled false otherwise

See Also:

I_CmsUploadService.cancelUpload()

checkUploadFiles

public CmsUploadFileBean checkUploadFiles(List<String> fileNames,
                                          String targetFolder)

Description copied from interface: I_CmsUploadService

Checks the availability of a resource in the VFS, using the CmsResourceFilter.IGNORE_EXPIRATION filter.

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

Specified by:

checkUploadFiles in interface I_CmsUploadService

Parameters:

fileNames - the filenames to check

targetFolder - the folder to check

Returns:

a 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

See Also:

I_CmsUploadService.checkUploadFiles(java.util.List, java.lang.String)

getUploadProgressInfo

public CmsUploadProgessInfo getUploadProgressInfo()

Description copied from interface: I_CmsUploadService

Returns the upload progress information.

Specified by:

getUploadProgressInfo in interface I_CmsUploadService

Returns:

the upload progress information

See Also:

I_CmsUploadService.getUploadProgressInfo()

prefetch

public CmsUploadData prefetch()

Description copied from interface: I_CmsUploadService

Generates upload data for prefetching in the host page.

Specified by:

prefetch in interface I_CmsUploadService

Returns:

the upload data

See Also:

I_CmsUploadService.prefetch()