com.hyfinity.xgate.upload

Interface FileUploadPlugin

public interface FileUploadPlugin

This interface must be used by any plugin that wishes to customise the file upload process for a given application. Each application can have one upload plugin defined if required, which must be specified through the xgate.xml configuration file. There will be one instance of this class created, so the processUpload method must be thread safe.

Version:

1.0

Author:

Hyfinity Ltd. Copyright (c) 2016

Method Summary

Methods

Modifier and Type	Method and Description
void	init(XPlatform xplatform) The init method will be called on startup of the application before any requests have been processed.
boolean	processUpload(org.apache.commons.fileupload.FileItem fi, org.w3c.dom.Element statusElem, XDocument message, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, RequestIdentification requestId) This is the main processing method for a FileUploadPlugin.

Method Detail

init

void init(XPlatform xplatform)

The init method will be called on startup of the application before any requests have been processed.

Parameters:

xplatform - The XPlatform instance for the application this plugin is attached to. This provides access to the platform logging and caching capabilities for example.

processUpload

boolean processUpload(org.apache.commons.fileupload.FileItem fi,
                    org.w3c.dom.Element statusElem,
                    XDocument message,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    RequestIdentification requestId)

This is the main processing method for a FileUploadPlugin. This will be called once for each individual file uploaded to the application, before the default handling takes place.

Parameters:

fi - The FileItem object representing the uploaded file to process.

statusElem - The XML Element that has been created to report the status of this file upload, and will eventually be inserted into the message. If you are returning false from this method to prevent the default behaviour then you should update this element directly. For example setting the success attribute, and errorMsg if appropriate.

message - The complete XML message that has been constructed so far from the incoming request, and will eventually be passed to the platform to process. File uploads are processed before sxforms so this will generally be the flat xg:attributes format at this point.

request - The HttpServletRequest object for the request that contained this file.

response - The HttpServletResponse object.

requestId - The unique ID details for this specific request. This should be used for any xplatform logging calls.

Returns:

A boolean which will control the default file upload processing for the specified file. If true is returned this file will be handled in the normal way. If false, then no further processing will be performed for this file.