Package org.wso2.carbon.ui.transports.fileupload

Class AbstractFileUploadExecutor

java.lang.Object

org.wso2.carbon.ui.transports.fileupload.AbstractFileUploadExecutor

Direct Known Subclasses:

AnyFileUploadExecutor, DBSFileUploadExecutor, JarZipUploadExecutor, KeyStoreFileUploadExecutor, ToolsAnyFileUploadExecutor, ToolsFileUploadExecutor

public abstract class AbstractFileUploadExecutor
extends Object

This class is responsible for handling File uploads of specific file types in Carbon. The file type is decided depending on the file extensio. This class should be extended by all FileUploadExecutors

See Also:

FileUploadExecutorManager

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.axis2.context.ConfigurationContext	configurationContext
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFileUploadExecutor()

Method Summary

Modifier and Type	Method	Description
protected void	checkServiceFileExtensionValidity(String fileExtension, String[] allowedExtensions)
abstract boolean	execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	executeCommon(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	This is the common method that can be used for Fileupload.
protected String	generateUUID()
protected List<org.wso2.carbon.utils.FileItemData>	getAllFileItems()
protected String	getContextRoot(javax.servlet.http.HttpServletRequest request)
protected String	getErrorRedirectionPage()
protected Map<String,ArrayList<org.wso2.carbon.utils.FileItemData>>	getFileItemsMap()
protected String	getFileName(String fileName)
protected Map<String,ArrayList<String>>	getFormFieldsMap()
List<String>	getFormFieldValue(String formFieldName)	Retrieve the form field values of the provided form field with name formFieldName
protected String	getWorkingDir()
protected void	parseRequest(javax.servlet.http.HttpServletRequest request)
protected List	parseRequest(org.apache.commons.fileupload.servlet.ServletRequestContext requestContext)
protected boolean	uploadArtifacts(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String uploadDirName, String[] extensions, String utilityString)	This is a helper method that will be used upload main entity (ex: wsdd, jar, class etc) and its resources to a given deployer.
protected File	uploadFile(javax.servlet.http.HttpServletRequest request, String repoDir, javax.servlet.http.HttpServletResponse response, String extension)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

configurationContext

protected org.apache.axis2.context.ConfigurationContext configurationContext

Constructor Detail

AbstractFileUploadExecutor

protected AbstractFileUploadExecutor()

Method Detail

execute

public abstract boolean execute(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws org.wso2.carbon.CarbonException,
                                IOException

Throws:

org.wso2.carbon.CarbonException

IOException

getErrorRedirectionPage

protected String getErrorRedirectionPage()

parseRequest

protected void parseRequest(javax.servlet.http.HttpServletRequest request)
                     throws FileUploadFailedException,
                            FileSizeLimitExceededException

Throws:

FileUploadFailedException

FileSizeLimitExceededException

getWorkingDir

protected String getWorkingDir()

generateUUID

protected String generateUUID()

getFileName

protected String getFileName(String fileName)

parseRequest

protected List parseRequest(org.apache.commons.fileupload.servlet.ServletRequestContext requestContext)
                     throws org.apache.commons.fileupload.FileUploadException

Throws:

org.apache.commons.fileupload.FileUploadException

checkServiceFileExtensionValidity

protected void checkServiceFileExtensionValidity(String fileExtension,
                                                 String[] allowedExtensions)
                                          throws org.apache.commons.fileupload.FileUploadException

Throws:

org.apache.commons.fileupload.FileUploadException

uploadFile

protected File uploadFile(javax.servlet.http.HttpServletRequest request,
                          String repoDir,
                          javax.servlet.http.HttpServletResponse response,
                          String extension)
                   throws org.apache.commons.fileupload.FileUploadException

Throws:

org.apache.commons.fileupload.FileUploadException

executeCommon

protected boolean executeCommon(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws org.apache.commons.fileupload.FileUploadException

This is the common method that can be used for Fileupload. extraStoreDirUUID is the name of the javascript that's going to execute on the client side at the secound run.

Parameters:

request -

response -

Returns:

Status true/fase.

Throws:

org.apache.commons.fileupload.FileUploadException

uploadArtifacts

protected boolean uploadArtifacts(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  String uploadDirName,
                                  String[] extensions,
                                  String utilityString)
                           throws org.apache.commons.fileupload.FileUploadException,
                                  IOException

This is a helper method that will be used upload main entity (ex: wsdd, jar, class etc) and its resources to a given deployer.

Parameters:

request -

response -

uploadDirName -

extensions -

utilityString -

Returns:

boolean

Throws:

IOException

org.apache.commons.fileupload.FileUploadException

getAllFileItems

protected List<org.wso2.carbon.utils.FileItemData> getAllFileItems()

getContextRoot

protected String getContextRoot(javax.servlet.http.HttpServletRequest request)

getFormFieldValue

public List<String> getFormFieldValue(String formFieldName)

Retrieve the form field values of the provided form field with name formFieldName

Parameters:

formFieldName - Name of the form field to be retrieved

Returns:

List of form field values

getFileItemsMap

protected Map<String,ArrayList<org.wso2.carbon.utils.FileItemData>> getFileItemsMap()

getFormFieldsMap

protected Map<String,ArrayList<String>> getFormFieldsMap()