org.imixs.workflow.jee.faces.fileupload

Class FileUploadController

java.lang.Object

org.imixs.workflow.jee.faces.fileupload.FileUploadController

All Implemented Interfaces:

Serializable

@Named(value="fileUploadController")
@SessionScoped
public class FileUploadController
extends Object
implements Serializable

This controller class provides methods to extract a file from a mulitpart http request. The controller also provides build-in functionality to store the uploaded files into a ItemCollection. A client can set a target WorkItem by calling setWorkitem(). If the WorkItem contains a property "$BlobWorkitem" the controller loads or creates an attached blobWorkitem. The property "$BlobWorkitem" contains than the $UniqueID of the blobWorkItem. The list of all currently uploaded files will be stored into the property $file. In case a BlobWorkitem is used the file content of this property will be empty! The FileUploadController implements a lazy loading mechanism. The BlobWorkitem will only be loaded by the Controller if a new Attachment need to to be stored. All other information can be read from the property $File stored in the parent WorkItem. The property 'RestServiceURI' allows the fileUploadController also to provide download urls which are pointing directly to the RestService interface.

See Also:

http://ironicprogrammer.blogspot.de/2010/03/file-upload-in-jsf2.html, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileUploadController()

Method Summary

Methods

Modifier and Type	Method and Description
void	doClear(javax.faces.event.ActionEvent e) Removes all new uploaded and removed Files.
void	doUpload(javax.faces.event.ActionEvent e) Adds a new file into the uploadedFiles property.
List<String>	getAttachedFiles() Returns a list of files contained by the current workitem.
List<String>	getRemovedFiles() Returns a list of files which where removed from the AttachedFiles list.
String	getRestServiceURI()
List<FileData>	getUploadedFiles() Returns a FileData list with uploaded files.
String	getWorkitemID()
boolean	isDirty() Indicates if one or more files where uploaded or a attached files were removed.
String	removeAttachmentAction(String sFilename) Removes a attached file object from the attachment list.
void	setAttachedFiles(List<String> attachedFiles) Updates the list of attached files.
void	setRemovedFiles(List<String> removedFiles)
void	setRestServiceURI(String restServiceURI)
void	setWorkitemID(String workitemID)
void	updateWorkitem(org.imixs.workflow.ItemCollection workitem, boolean noContent) Synchronize the current file list with an WorkItem.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUploadController

public FileUploadController()

Method Detail

getRestServiceURI

public String getRestServiceURI()

setRestServiceURI

public void setRestServiceURI(String restServiceURI)

getWorkitemID

public String getWorkitemID()

setWorkitemID

public void setWorkitemID(String workitemID)

getAttachedFiles

public List<String> getAttachedFiles()

Returns a list of files contained by the current workitem.

Returns:

setAttachedFiles

public void setAttachedFiles(List<String> attachedFiles)

Updates the list of attached files.

Parameters:

attachedFiles -

getRemovedFiles

public List<String> getRemovedFiles()

Returns a list of files which where removed from the AttachedFiles list.

Returns:

setRemovedFiles

public void setRemovedFiles(List<String> removedFiles)

getUploadedFiles

public List<FileData> getUploadedFiles()

Returns a FileData list with uploaded files. This method can be used from a client to store the file content into a database.

Returns:

- a list of FileData objects

doUpload

public void doUpload(javax.faces.event.ActionEvent e)

Adds a new file into the uploadedFiles property. The file Data is converted into a FileData object. A client can call the method 'updateWorkitem' to synchronize a WorkItem with the new uploaded files.

Parameters:

e -

removeAttachmentAction

public String removeAttachmentAction(String sFilename)

Removes a attached file object from the attachment list. A client can call the method 'updateWorkitem' to synchronize a WorkItem with the new uploaded files.

Parameters:

sFilename - - filename to be removed

Returns:

- null

isDirty

public boolean isDirty()

Indicates if one or more files where uploaded or a attached files were removed. A client can call the method to check if an update of a Workitem is necessary.

Returns:

- true if content has changed

doClear

public void doClear(javax.faces.event.ActionEvent e)

Removes all new uploaded and removed Files. Clears the dirty flag.

Parameters:

e - - action event

updateWorkitem

public void updateWorkitem(org.imixs.workflow.ItemCollection workitem,
                  boolean noContent)

Synchronize the current file list with an WorkItem. The method adds all new uploaded files into the WorkItem and deletes files which where removed from the list. A client can call 'isDirty' to ask if any changes where made. The parameter 'noContent' indicates if the content should be stored. If 'true' only the fileNames will be added into the given workItem. This is used for lazy loading implementations.

Parameters:

workitem - - workItem to store the uploaded files

noContent - - if true only file names will be stored.