com.neurosys.site.wicket.components.wrappers

Class FileUploadWrapper

java.lang.Object

com.neurosys.site.wicket.components.wrappers.FileUploadWrapper

@Component
public class FileUploadWrapper
extends Object

Sample Usage:
@see this#upload(String, WebMarkupContainer, String)

String savedPath = imageUploader.upload("filePicUpload", this, 'Folder where images go'>); Where imageUploader can be a Spring reference to this component.

Assumes a context with appConfiguration & adminConfiguration defined with the following properties:

• site.resources.folder.mode.relative : If true then this means path relative to web-context ok for testing apps; if false then then its an absolute path relative to an external base folder
• site.resources.folder.models.default : Default path to save the files
• site.resources.folder.base : Location of external base folder, used if site.resources.folder.mode.relative is false

This is a wrapper code that enforces various upload policies, configurations, compression, base/absolute config resolution and exception handling code over raw upload code.

Author:

Arjun Dhar

See Also:

Wicket File Upload Samples, Wicket Multi-File Upload Sammple

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileUploadWrapper.CompressionMeta

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPLOAD_FILE_SIZE_MAX_KB_KEY

Constructor Summary

Constructors

Constructor and Description
FileUploadWrapper()

Method Summary

Modifier and Type	Method and Description
static String	constructAbsoluteDownloadPath(String path)
static FileUploadWrapper	get()
String	getDownloadPath(String savedPath) Based on site.resources.folder.mode.relative config being absolute or relative; it constructs a 'DownloadServlet?file=' path, if absolute paths are being used.
Long	getFileUploadSizeMaxKB()
String	getRelativePath(String absolutePath) Get path of the resource relative to the base folder.
List<String>	getResourceFolderAbsolutePaths() Irrespective of web-relative or not, it derives the absolute path for the resources base folder(s).
List<String>	getResourceFolderbasePaths() Default configured to property from admin configs : site.resources.folder.base
String	getWebRelativePath(String path) Get path to display to user which they can use.
protected void	initStaticVariables()
boolean	isResourceRelativeToWebContext()
String	upload(org.apache.wicket.markup.html.form.upload.FileUpload fileUploadHandle, org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent, String uploadFolder, FileUploadWrapper.CompressionMeta compressionMeta) Will return path Relative to Web-Context or to FileSystrem base Path (depending on Relative or Absolute configuration). This will never return ABSOLUTE PATH.
String	upload(org.apache.wicket.markup.html.form.upload.FileUpload fileUploadHandle, org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent, String uploadFolder, String defaultAbsolutePath, FileUploadWrapper.CompressionMeta compressionMeta, Boolean uploadFolderIsAbsolute) Will return path Relative to Web-Context or to FileSystrem base Path (depending on Relative or Absolute configuration). This will never return ABSOLUTE PATH.
String	upload(String fileUploadFieldName, org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent, String uploadFolder, FileUploadWrapper.CompressionMeta compressionMeta)
Collection<String>	uploadMultiple(org.apache.wicket.markup.html.form.upload.MultiFileUploadField fileUploadField, org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent, String uploadFolder, FileUploadWrapper.CompressionMeta compressionMeta) Upload multiple files
Collection<String>	uploadMultiple(String fileUploadFieldName, org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent, String uploadFolder, FileUploadWrapper.CompressionMeta compressionMeta) Upload multiple files

Methods inherited from class java.lang.Object

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

Field Detail

UPLOAD_FILE_SIZE_MAX_KB_KEY

public static final String UPLOAD_FILE_SIZE_MAX_KB_KEY

See Also:

Constant Field Values

Constructor Detail

FileUploadWrapper

public FileUploadWrapper()

Method Detail

initStaticVariables

@PostConstruct
protected void initStaticVariables()

getWebRelativePath

public String getWebRelativePath(String path)
                          throws Exception

Get path to display to user which they can use. The relative one is what they can use to access it from the Web.
Note: because this method depends on the path from the properties that is injected via Spring etc, it is non-static. We could make it static, but the hacks are not necessary at the moment from a API usage perspective.

Parameters:

path -

Returns:

Throws:

Exception

getRelativePath

public String getRelativePath(String absolutePath)
                       throws Exception

Get path of the resource relative to the base folder.

Parameters:

absolutePath -

Returns:

Throws:

Exception

getResourceFolderAbsolutePaths

public List<String> getResourceFolderAbsolutePaths()

Irrespective of web-relative or not, it derives the absolute path for the resources base folder(s).

Returns:

upload

public String upload(String fileUploadFieldName,
                     org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent,
                     String uploadFolder,
                     FileUploadWrapper.CompressionMeta compressionMeta)

Parameters:

fileUploadFieldName - as the Wicket FileUploadField field name

parentWebComponent - the Wicket calling this method / or container of the File Uploader (could be different). Supporting form should support Multi-Part.

uploadFolder -

compressionMeta - as FileUploadWrapper.CompressionMeta
Nullable true. If null then defaults from adminConfiguration will apply.
Default being site.upload.image.compression.qualityfactor & site.upload.image.compression.minSizeForCompressionToApplyBytes

Returns:

String (final saved location)

upload

public String upload(org.apache.wicket.markup.html.form.upload.FileUpload fileUploadHandle,
                     org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent,
                     String uploadFolder,
                     FileUploadWrapper.CompressionMeta compressionMeta)

Will return path Relative to Web-Context or to FileSystrem base Path (depending on Relative or Absolute configuration).
This will never return ABSOLUTE PATH.

Parameters:

fileUploadHandle - as the Wicket FileUploadField field

parentWebComponent - the Wicket calling this method / or container of the File Uploader (could be different). Supporting form should support Multi-Part.

uploadFolder -

compressionMeta - as FileUploadWrapper.CompressionMeta
Nullable true. If null then defaults from adminConfiguration will apply.
Default being site.upload.image.compression.qualityfactor & site.upload.image.compression.minSizeForCompressionToApplyBytes

Returns:

String (final saved location)

upload

public String upload(org.apache.wicket.markup.html.form.upload.FileUpload fileUploadHandle,
                     org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent,
                     String uploadFolder,
                     String defaultAbsolutePath,
                     FileUploadWrapper.CompressionMeta compressionMeta,
                     Boolean uploadFolderIsAbsolute)

Will return path Relative to Web-Context or to FileSystrem base Path (depending on Relative or Absolute configuration).
This will never return ABSOLUTE PATH.

Parameters:

fileUploadHandle - as the Wicket FileUploadField field

parentWebComponent - the Wicket calling this method / or container of the File Uploader (could be different). Supporting form should support Multi-Part. @nullable true

uploadFolder - (should be a valid existing file or folder. If a file it will derive the parent folder from it) isResourceRelativeToWebContext() then this path is expected to be a relative Path to the AppSettings.get().CONTEXT_BASE_ABSOLUTE_PATH

defaultAbsolutePath -

compressionMeta - as FileUploadWrapper.CompressionMeta
Nullable true. If null then defaults from adminConfiguration will apply.
Default being site.upload.image.compression.qualityfactor & site.upload.image.compression.minSizeForCompressionToApplyBytes

uploadFolderIsRelative - as boolean. By Default isResourceRelativeToWebContext() is consulted, but in certain situations even when using relative paths we may want to supply an Absolute path. Then can supply true in that case. "null" is dont know/will imply default.

Returns:

String (final saved location absolute path)

uploadMultiple

public Collection<String> uploadMultiple(String fileUploadFieldName,
                                         org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent,
                                         String uploadFolder,
                                         FileUploadWrapper.CompressionMeta compressionMeta)

Upload multiple files

Parameters:

fileUploadFieldName - as the Wicket MultiFileUploadField field

parentWebComponent - the Wicket calling this method / or container of the File Uploader (could be different). Supporting form should support Multi-Part.

uploadFolder -

Returns:

String (final saved location)

uploadMultiple

public Collection<String> uploadMultiple(org.apache.wicket.markup.html.form.upload.MultiFileUploadField fileUploadField,
                                         org.apache.wicket.markup.html.WebMarkupContainer parentWebComponent,
                                         String uploadFolder,
                                         FileUploadWrapper.CompressionMeta compressionMeta)

Upload multiple files

Parameters:

fileUploadFieldName - as the Wicket MultiFileUploadField field name

parentWebComponent - the Wicket calling this method / or container of the File Uploader (could be different). Supporting form should support Multi-Part.

uploadFolder -

Returns:

String (final saved location)

getDownloadPath

public String getDownloadPath(String savedPath)

Based on site.resources.folder.mode.relative config being absolute or relative; it constructs a 'DownloadServlet?file=' path, if absolute paths are being used.

Parameters:

savedPath -

Returns:

constructAbsoluteDownloadPath

public static String constructAbsoluteDownloadPath(String path)

get

public static FileUploadWrapper get()

isResourceRelativeToWebContext

public boolean isResourceRelativeToWebContext()

getResourceFolderbasePaths

public List<String> getResourceFolderbasePaths()

Default configured to property from admin configs : site.resources.folder.base

getFileUploadSizeMaxKB

public Long getFileUploadSizeMaxKB()