Package org.exoplatform.upload

Class UploadService

java.lang.Object

org.exoplatform.upload.UploadService

public class UploadService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UploadService.UploadLimit
static enum	UploadService.UploadUnit

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UPLOAD_RESOURCES_STACK

Constructor Summary

Constructors

Constructor	Description
UploadService(org.exoplatform.container.xml.PortalContainerInfo pinfo, org.exoplatform.container.xml.InitParams params)

Method Summary

Modifier and Type	Method	Description
void	addUploadLimit(String uploadId, Integer limitMB)	Registry upload limit size for uploadLimitsMB_.
void	addUploadLimit(String uploadId, Integer limit, UploadService.UploadUnit unit)
void	cleanUp(jakarta.servlet.http.HttpSession session)	Clean up temporary files that are uploaded in the Session but not removed yet
String	correctFileName(String fileName)
void	createUploadResource(jakarta.servlet.http.HttpServletRequest request)	Create UploadResource for HttpServletRequest
void	createUploadResource(String uploadId, jakarta.servlet.http.HttpServletRequest request)
void	createUploadResource(String uploadId, String encoding, String contentType, double contentLength, InputStream inputStream)	Deprecated. use createUploadResource(String, jakarta.servlet.http.HttpServletRequest) instead
void	createUploadResource(UploadResource uploadResource)
UploadService.UploadLimit	getLimitForResource(UploadResource upResource)
Map<String,UploadService.UploadLimit>	getUploadLimits()	Get all upload limit sizes
UploadResource	getUploadResource(String uploadId)	Get UploadResource by uploadId
boolean	isLimited(UploadResource upResource, double contentLength)
void	register(MimeTypeUploadPlugin plugin)
void	removeUpload(String uploadId)	Deprecated. use removeUploadResource(String) instead
void	removeUploadLimit(String uploadId)
void	removeUploadResource(String uploadId)	Remove the UploadResource and its temporary file that associated with given uploadId.

Methods inherited from class java.lang.Object

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

Field Details

UPLOAD_RESOURCES_STACK

public static final String UPLOAD_RESOURCES_STACK

See Also:

• Constant Field Values

Constructor Details

UploadService

public UploadService(org.exoplatform.container.xml.PortalContainerInfo pinfo,
 org.exoplatform.container.xml.InitParams params)
              throws Exception

Throws:

Exception

Method Details

register

public void register(MimeTypeUploadPlugin plugin)

createUploadResource

public void createUploadResource(jakarta.servlet.http.HttpServletRequest request)
                          throws org.apache.commons.fileupload2.core.FileUploadException

Create UploadResource for HttpServletRequest

Parameters:

request - the webapp's HttpServletRequest

Throws:

org.apache.commons.fileupload2.core.FileUploadException

createUploadResource

public void createUploadResource(UploadResource uploadResource)

createUploadResource

public void createUploadResource(String uploadId,
 jakarta.servlet.http.HttpServletRequest request)
                          throws org.apache.commons.fileupload2.core.FileUploadException

Throws:

org.apache.commons.fileupload2.core.FileUploadException

createUploadResource

public void createUploadResource(String uploadId,
 String encoding,
 String contentType,
 double contentLength,
 InputStream inputStream)
                          throws Exception

Deprecated.

use createUploadResource(String, jakarta.servlet.http.HttpServletRequest) instead

Throws:

Exception

getUploadResource

public UploadResource getUploadResource(String uploadId)

Get UploadResource by uploadId

Parameters:

uploadId - uploadId of UploadResource

Returns:

org.exoplatform.upload.UploadResource of uploadId

cleanUp

public void cleanUp(jakarta.servlet.http.HttpSession session)

Clean up temporary files that are uploaded in the Session but not removed yet

Parameters:

session -

removeUpload

@Deprecated
public void removeUpload(String uploadId)

Deprecated.

use removeUploadResource(String) instead

Parameters:

uploadId -

removeUploadResource

public void removeUploadResource(String uploadId)

Remove the UploadResource and its temporary file that associated with given uploadId.
If uploadId is null or UploadResource is null, do nothing

Parameters:

uploadId - uploadId of UploadResource will be removed

addUploadLimit

public void addUploadLimit(String uploadId,
 Integer limitMB)

Registry upload limit size for uploadLimitsMB_. If limitMB is null, defaultUploadLimitMB_ will be registried

Parameters:

uploadId -

limitMB - upload limit size

addUploadLimit

public void addUploadLimit(String uploadId,
 Integer limit,
 UploadService.UploadUnit unit)

removeUploadLimit

public void removeUploadLimit(String uploadId)

getUploadLimits

public Map<String,UploadService.UploadLimit> getUploadLimits()

Get all upload limit sizes

Returns:

all upload limit sizes

correctFileName

public String correctFileName(String fileName)

isLimited

public boolean isLimited(UploadResource upResource,
 double contentLength)

getLimitForResource

public UploadService.UploadLimit getLimitForResource(UploadResource upResource)