Package org.ametys.plugins.core.impl.upload

Class FSUploadManager

java.lang.Object

org.ametys.plugins.core.impl.upload.FSUploadManager

All Implemented Interfaces:

UploadManager, Initializable, Component, Contextualizable, LogEnabled, ThreadSafe

public class FSUploadManager
extends Object
implements UploadManager, ThreadSafe, Initializable, LogEnabled, Contextualizable

UploadManager which stores uploaded files into the uploads-user directory located in Ametys home

Note that this implementation is not cluster safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FSUploadManager.FSUpload	Upload implementation on file system.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_cocoonContext	Context.
protected File	_globalUploadsDir	Global uploads directory.
static final String	UPLOADS_DIRECTORY	The path to the global uploads directory relative to ametys home

Fields inherited from interface org.ametys.core.upload.UploadManager

ROLE

Constructor Summary

Constructors

Constructor	Description
FSUploadManager()

Method Summary

Modifier and Type	Method	Description
protected File	_getUploadDir(String login, String id)	Retrieves the upload directory for a login and an upload id.
void	contextualize(Context context)
void	enableLogging(Logger logger)
Upload	getUpload(UserIdentity user, String id)	Retrieves a previous file uploaded by an user.
File[]	getUploadsDirectories()	get directories under upload-user directory
void	initialize()
Upload	storeUpload(UserIdentity user, String filename, InputStream is)	Stores a file uploaded by an user.

Methods inherited from class java.lang.Object

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

Field Details

UPLOADS_DIRECTORY

public static final String UPLOADS_DIRECTORY

The path to the global uploads directory relative to ametys home

See Also:

• Constant Field Values

_cocoonContext

protected Context _cocoonContext

Context.

_globalUploadsDir

protected File _globalUploadsDir

Global uploads directory.

Constructor Details

FSUploadManager

public FSUploadManager()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

enableLogging

public void enableLogging(Logger logger)

Specified by:

enableLogging in interface LogEnabled

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

storeUpload

public Upload storeUpload(UserIdentity user,
 String filename,
 InputStream is)
                   throws IOException

Description copied from interface: UploadManager

Stores a file uploaded by an user.

Specified by:

storeUpload in interface UploadManager

Parameters:

user - the user.

filename - the upload filename.

is - the upload data.

Returns:

the upload.

Throws:

IOException - if an error occurs.

getUpload

public Upload getUpload(UserIdentity user,
 String id)
                 throws NoSuchElementException

Description copied from interface: UploadManager

Retrieves a previous file uploaded by an user.

Specified by:

getUpload in interface UploadManager

Parameters:

user - the user.

id - the upload id.

Returns:

the upload.

Throws:

NoSuchElementException - if there is no upload for this parameters.

_getUploadDir

protected File _getUploadDir(String login,
 String id)

Retrieves the upload directory for a login and an upload id.

Parameters:

login - the login.

id - the upload id.

Returns:

the upload directory.

getUploadsDirectories

public File[] getUploadsDirectories()

get directories under upload-user directory

Returns:

the directories