fr.paris.lutece.plugins.directory.service.upload

Class DirectoryAsynchronousUploadHandler

java.lang.Object

fr.paris.lutece.plugins.directory.service.upload.DirectoryAsynchronousUploadHandler

All Implemented Interfaces:

fr.paris.lutece.portal.web.upload.IAsynchronousUploadHandler

public class DirectoryAsynchronousUploadHandler
extends Object
implements fr.paris.lutece.portal.web.upload.IAsynchronousUploadHandler

Handler for asynchronous uploads. The jessionid parameter should be the REAL session id, not the flash player one. The uploaded files are deleted by SubForm when filling fields.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,Map<String,List<org.apache.commons.fileupload.FileItem>>>	_mapAsynchronousUpload <sessionId,<fieldName,fileItems>>

Method Summary

Modifier and Type	Method and Description
void	addFileItemToUploadedFile(org.apache.commons.fileupload.FileItem fileItem, String strIdEntry, javax.servlet.http.HttpSession session) Add file item to the list of uploaded files
String	buildFieldName(String strIdEntry) Build the field name from a given id entry i.e.
void	doDeleteFile(javax.servlet.http.HttpServletRequest request, String strIdEntry, Map<String,List<RecordField>> map) Deletes a file
org.apache.commons.fileupload.FileItem	doDownloadFile(String strUrl) Do download the file
void	doDownloadFile(String strUrl, String strFilePath) Do download the file
void	doRemoveFile(RecordField recordField, IEntry entry, String strWSRestUrl) Do remove a file from a given record field
void	doRemoveFile(Record record, IEntry entry, String strWSRestUrl) Do remove a file from a given record and entry
void	doUploadAction(javax.servlet.http.HttpServletRequest request, String strUploadAction, Map<String,List<RecordField>> map) Performs an upload action.
void	doUploadAction(javax.servlet.http.HttpServletRequest request, String strUploadAction, Map<String,List<RecordField>> map, Record record, fr.paris.lutece.portal.service.plugin.Plugin plugin) Performs an upload action.
void	doUploadFile(javax.servlet.http.HttpServletRequest request, String strIdEntry, Map<String,List<RecordField>> map) Uploads a file
void	doUploadFile(javax.servlet.http.HttpServletRequest request, String strIdEntry, Map<String,List<RecordField>> map, Record record) Uploads a file
String	doUploadFile(String strBaseUrl, org.apache.commons.fileupload.FileItem fileItem, String strBlobStore) Do upload a file in the blobstore webapp
List<org.apache.commons.fileupload.FileItem>	getFileItems(String strIdEntry, String strSessionId) Gets the fileItem for the entry and the given session.
String	getFileName(String strUrl) Get the file name from a given url
String	getFileUrl(String strBaseUrl, String strBlobKey, String strBlobStore) Get the file url
static DirectoryAsynchronousUploadHandler	getHandler() Get the handler
String	getUploadAction(javax.servlet.http.HttpServletRequest request) Checks the request parameters to see if an upload submit has been called.
boolean	isBlobStoreClientServiceAvailable() Check if the service is available
boolean	isInvoked(javax.servlet.http.HttpServletRequest request)
void	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, net.sf.json.JSONObject mainObject, List<org.apache.commons.fileupload.FileItem> listFileItemsToUpload) category CALLED_BY_JS (directoryupload.js)
void	reinitMap(javax.servlet.http.HttpServletRequest request, Map<String,List<RecordField>> map, fr.paris.lutece.portal.service.plugin.Plugin plugin) Reinit the map with the default files stored in database and blobstore
void	removeFileItem(String strIdEntry, String strSessionId, int nIndex) Removes the file from the list.
void	removeSessionFiles(String strSessionId) Removes all files associated to the session
void	setBlobStoreClientService(fr.paris.lutece.plugins.blobstore.service.IBlobStoreClientService blobStoreClientService) Set the blobstore client service

Methods inherited from class java.lang.Object

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

Field Detail

_mapAsynchronousUpload

public static Map<String,Map<String,List<org.apache.commons.fileupload.FileItem>>> _mapAsynchronousUpload

<sessionId,<fieldName,fileItems>>

Method Detail

getHandler

public static DirectoryAsynchronousUploadHandler getHandler()

Get the handler

Returns:

the handler

setBlobStoreClientService

public void setBlobStoreClientService(fr.paris.lutece.plugins.blobstore.service.IBlobStoreClientService blobStoreClientService)

Set the blobstore client service

Parameters:

blobStoreClientService - the blob store client service

isInvoked

public boolean isInvoked(javax.servlet.http.HttpServletRequest request)

Specified by:

isInvoked in interface fr.paris.lutece.portal.web.upload.IAsynchronousUploadHandler

isBlobStoreClientServiceAvailable

public boolean isBlobStoreClientServiceAvailable()

Check if the service is available

Returns:

true if the service is available, false otherwise

process

public void process(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    net.sf.json.JSONObject mainObject,
                    List<org.apache.commons.fileupload.FileItem> listFileItemsToUpload)

category CALLED_BY_JS (directoryupload.js)

Specified by:

process in interface fr.paris.lutece.portal.web.upload.IAsynchronousUploadHandler

doUploadFile

public String doUploadFile(String strBaseUrl,
                           org.apache.commons.fileupload.FileItem fileItem,
                           String strBlobStore)
                    throws fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException

Do upload a file in the blobstore webapp

Parameters:

strBaseUrl - the base url

fileItem - the file

strBlobStore - the blobstore service name

Returns:

the blob key of the uploaded file

Throws:

fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException - Exception if there is an issue

doRemoveFile

public void doRemoveFile(Record record,
                         IEntry entry,
                         String strWSRestUrl)
                  throws fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException

Do remove a file from a given record and entry

Parameters:

record - the record

entry - the entry

strWSRestUrl - the url of the WS rest

Throws:

fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException - Exception if there is an issue

doRemoveFile

public void doRemoveFile(RecordField recordField,
                         IEntry entry,
                         String strWSRestUrl)
                  throws fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException

Do remove a file from a given record field

Parameters:

recordField - the record field

entry - the entry

strWSRestUrl - the url of the WS rest

Throws:

fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException - Exception if there is an issue

getFileUrl

public String getFileUrl(String strBaseUrl,
                         String strBlobKey,
                         String strBlobStore)
                  throws fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException

Get the file url

Parameters:

strBaseUrl - the base url

strBlobKey - the blob key

strBlobStore - the blobstore service name

Returns:

the file url

Throws:

fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException - Exception if there is an issue

getFileName

public String getFileName(String strUrl)
                   throws fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException

Get the file name from a given url

Parameters:

strUrl - the url

Returns:

the file name

Throws:

fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException - Exception if there is an issue

doDownloadFile

public void doDownloadFile(String strUrl,
                           String strFilePath)
                    throws fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException

Do download the file

Parameters:

strUrl - the file of the file to download

strFilePath - the file path to download

Throws:

fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException - exception if there is an error

doDownloadFile

public org.apache.commons.fileupload.FileItem doDownloadFile(String strUrl)
                                                      throws fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException

Do download the file

Parameters:

strUrl - the file of the file to download

Returns:

a FileItem

Throws:

fr.paris.lutece.plugins.blobstore.service.BlobStoreClientException - exception if there is an error

getFileItems

public List<org.apache.commons.fileupload.FileItem> getFileItems(String strIdEntry,
                                                                 String strSessionId)

Gets the fileItem for the entry and the given session.

Parameters:

strIdEntry - the entry

strSessionId - the session id

Returns:

the fileItem found, null otherwise.

removeFileItem

public void removeFileItem(String strIdEntry,
                           String strSessionId,
                           int nIndex)

Removes the file from the list.

Parameters:

strIdEntry - the entry id

strSessionId - the session id

nIndex - the n index

removeSessionFiles

public void removeSessionFiles(String strSessionId)

Removes all files associated to the session

Parameters:

strSessionId - the session id

addFileItemToUploadedFile

public void addFileItemToUploadedFile(org.apache.commons.fileupload.FileItem fileItem,
                                      String strIdEntry,
                                      javax.servlet.http.HttpSession session)

Add file item to the list of uploaded files

Parameters:

fileItem - the file item

strIdEntry - the id entry

session - the session

buildFieldName

public String buildFieldName(String strIdEntry)

Build the field name from a given id entry i.e. : directory_1

Parameters:

strIdEntry - the id entry

Returns:

the field name

getUploadAction

public String getUploadAction(javax.servlet.http.HttpServletRequest request)

Checks the request parameters to see if an upload submit has been called.

Parameters:

request - the HTTP request

Returns:

the name of the upload action, if any. Null otherwise.

doUploadAction

public void doUploadAction(javax.servlet.http.HttpServletRequest request,
                           String strUploadAction,
                           Map<String,List<RecordField>> map,
                           Record record,
                           fr.paris.lutece.portal.service.plugin.Plugin plugin)
                    throws DirectoryErrorException

Performs an upload action.

Parameters:

request - the HTTP request

strUploadAction - the name of the upload action

map - the map of idEntry, RecordFields

record - the record

plugin - the plugin

Throws:

DirectoryErrorException - exception if there is an error

doUploadFile

public void doUploadFile(javax.servlet.http.HttpServletRequest request,
                         String strIdEntry,
                         Map<String,List<RecordField>> map,
                         Record record)
                  throws DirectoryErrorException

Uploads a file

Parameters:

request - the request containing the file to upload

strIdEntry - the entry id linked to the file

map - the map of RecordFields

record - the record on which the file is added

Throws:

DirectoryErrorException - if there is an error during the upload

doDeleteFile

public void doDeleteFile(javax.servlet.http.HttpServletRequest request,
                         String strIdEntry,
                         Map<String,List<RecordField>> map)

Deletes a file

Parameters:

request - the request containing the file to delete

strIdEntry - the entry id linked to the file

map - the map of RecordFields

doUploadAction

public void doUploadAction(javax.servlet.http.HttpServletRequest request,
                           String strUploadAction,
                           Map<String,List<RecordField>> map)
                    throws DirectoryErrorException

Performs an upload action.

Parameters:

request - the HTTP request

strUploadAction - the name of the upload action

map - the map of idEntry, RecordFields

Throws:

DirectoryErrorException - exception if there is an error

doUploadFile

public void doUploadFile(javax.servlet.http.HttpServletRequest request,
                         String strIdEntry,
                         Map<String,List<RecordField>> map)
                  throws DirectoryErrorException

Uploads a file

Parameters:

request - the request containing the file to upload

strIdEntry - the entry id linked to the file

map - the map of RecordFields

Throws:

DirectoryErrorException - if there is an error during the upload

reinitMap

public void reinitMap(javax.servlet.http.HttpServletRequest request,
                      Map<String,List<RecordField>> map,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)

Reinit the map with the default files stored in database and blobstore

Parameters:

request - the HTTP request

map - the map idEntry, RecordFields

plugin - the plugin