Package org.ametys.plugins.core.upload

Class UploadAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.core.util.cocoon.AbstractCurrentUserProviderServiceableAction

org.ametys.plugins.core.upload.UploadAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, Action

Direct Known Subclasses:

CropImageAction, UploadAction

public class UploadAction
extends AbstractCurrentUserProviderServiceableAction

Action for uploading a file and store it using the UploadManager.

Field Summary

Fields

Modifier and Type	Field	Description
protected UploadManager	_uploadManager	The Upload Manager

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor	Description
UploadAction()

Method Summary

Modifier and Type	Method	Description
protected void	_doUpload(Request request, Parameters parameters, Map<String,Object> result)	Do upload the file and fill the result map.
protected void	_fillSuccess(Upload upload, Map<String,Object> result)	Fill the result map.
protected Part	_getPart(Request request)	Gets the Part object which is trying to be uploaded
protected String	_getUrlForDownload(Upload upload)	Get the url for download the uploaded file
protected String	_getUrlForView(Upload upload)	Get the url for view the uploaded file
protected void	_handleStoreUploadException(IOException e, Object obj, Map<String,Object> result)	Handles a store upload exception by filling the result map with information about the exception.
protected void	_lookupComponents()	Lookup components (lazy initialize)
protected void	_storeUpload(InputStream is, String filename, Map<String,Object> result)	Stores the given upload data (as an InputStream) into the UploadManager system and fill the result map.
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)

Methods inherited from class org.ametys.core.util.cocoon.AbstractCurrentUserProviderServiceableAction

_getCurrentUser

Methods inherited from class org.apache.cocoon.acting.ServiceableAction

service

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_uploadManager

protected UploadManager _uploadManager

The Upload Manager

Constructor Detail

UploadAction

public UploadAction()

Method Detail

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception

Throws:

Exception

_lookupComponents

protected void _lookupComponents()
                          throws ServiceException

Lookup components (lazy initialize)

Throws:

ServiceException - If some components cannot be looked up

_doUpload

protected void _doUpload(Request request,
                         Parameters parameters,
                         Map<String,Object> result)
                  throws Exception

Do upload the file and fill the result map.

Parameters:

request - The request

parameters - The parameters

result - The result map to fill

Throws:

Exception - if an error occurs.

_getPart

protected Part _getPart(Request request)
                 throws Exception

Gets the Part object which is trying to be uploaded

Parameters:

request - The request

Returns:

The Part object which is trying to be uploaded

Throws:

Exception - if an error occurs.

_storeUpload

protected void _storeUpload(InputStream is,
                            String filename,
                            Map<String,Object> result)
                     throws IOException

Stores the given upload data (as an InputStream) into the UploadManager system and fill the result map.

Parameters:

is - The upload data

filename - The file name

result - The result map to fill

Throws:

IOException - if an I/O error occurs

_fillSuccess

protected void _fillSuccess(Upload upload,
                            Map<String,Object> result)

Fill the result map.

Parameters:

upload - The upload

result - The result map to fill

_handleStoreUploadException

protected void _handleStoreUploadException(IOException e,
                                           Object obj,
                                           Map<String,Object> result)

Handles a store upload exception by filling the result map with information about the exception.

Parameters:

e - The exception

obj - The object representing the upload data (for logging purpose)

result - The result map to fill

_getUrlForView

protected String _getUrlForView(Upload upload)

Get the url for view the uploaded file

Parameters:

upload - The file uploaded

Returns:

The url for view

_getUrlForDownload

protected String _getUrlForDownload(Upload upload)

Get the url for download the uploaded file

Parameters:

upload - The file uploaded

Returns:

The url for view