org.openi.web.controller.admin
Class ManageFilesFormController

java.lang.Object
  extended by org.springframework.context.support.ApplicationObjectSupport
      extended by org.springframework.web.context.support.WebApplicationObjectSupport
          extended by org.springframework.web.servlet.support.WebContentGenerator
              extended by org.springframework.web.servlet.mvc.AbstractController
                  extended by org.springframework.web.servlet.mvc.BaseCommandController
                      extended by org.springframework.web.servlet.mvc.AbstractFormController
                          extended by org.springframework.web.servlet.mvc.SimpleFormController
                              extended by org.openi.web.controller.admin.ManageFilesFormController
All Implemented Interfaces:
org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class ManageFilesFormController
extends org.springframework.web.servlet.mvc.SimpleFormController

Controller to handle manage files request. Allows to edit/delete/rename project content.

This controller is mapped for private and public request as '/managefiles.htm' and '/manageprivatefiles.htm' respectively. So if '/manageprivatefiles.htm' is requested, it only allows to manage private content of the current user. You can protect /managefiles.htm(which allows to edit both private and public content) from SecurityConfiguration available in manage app.

Author:
Uddhab Pant, Dipendra Pokhrel

Field Summary
static java.lang.String DELETE_FOLDERFILE_VIEW
           
static java.lang.String EDIT_FILE_VIEW
           
static java.lang.String MAIN_VIEW
           
static java.lang.String NEW_FOLDER_VIEW
           
static java.lang.String RENAME_FOLDER_FILE_VIEW
           
static java.lang.String SERVLET_PATH
           
 
Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController
DEFAULT_COMMAND_NAME
 
Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator
METHOD_GET, METHOD_HEAD, METHOD_POST
 
Constructor Summary
ManageFilesFormController()
           
 
Method Summary
protected  java.lang.Object formBackingObject(javax.servlet.http.HttpServletRequest request)
          This method will create the command object and set it in its initial state.
 java.util.List getEditableFileTypes()
           
 Folder getFolderRoot()
          used by test case
 java.lang.String getPrivateSuccessView()
           
 java.lang.String getXslTemplate()
           
protected  org.springframework.web.servlet.ModelAndView handleCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
          This method handles cancel action and redirects to manage file page.
protected  org.springframework.web.servlet.ModelAndView handleClick(java.lang.String action, java.lang.String path, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
          This method handles submit action requested by clicking icons.
protected  org.springframework.web.servlet.ModelAndView handleCreate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
          This method handles create action.
protected  org.springframework.web.servlet.ModelAndView handleDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
          This method handles delete action.
protected  org.springframework.web.servlet.ModelAndView handleRename(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
          handles rename action
protected  org.springframework.web.servlet.ModelAndView handleSaveFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
          Saves edited text file
protected  org.springframework.web.servlet.ModelAndView onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object command, org.springframework.validation.BindException errors)
          Submit callback with all parameters.
 void setEditableFileTypes(java.util.List editableFileTypes)
           
 void setPrivateSuccessView(java.lang.String privateSuccessView)
           
 void setXslTemplate(java.lang.String xslTemplate)
          set by spring
 
Methods inherited from class org.springframework.web.servlet.mvc.SimpleFormController
doSubmitAction, getFormView, getSuccessView, isFormChangeRequest, onFormChange, onFormChange, onSubmit, onSubmit, processFormSubmission, referenceData, referenceData, setFormView, setSuccessView, showForm, showForm, suppressValidation
 
Methods inherited from class org.springframework.web.servlet.mvc.AbstractFormController
currentFormObject, getCommand, getErrorsForNewForm, getFormSessionAttributeName, getFormSessionAttributeName, handleInvalidSubmit, handleRequestInternal, isBindOnNewForm, isFormSubmission, isSessionForm, onBindOnNewForm, onBindOnNewForm, setBindOnNewForm, setSessionForm, showForm, showForm, showNewForm
 
Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController
bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, initApplicationContext, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, suppressBinding, useDirectFieldAccess
 
Methods inherited from class org.springframework.web.servlet.mvc.AbstractController
handleRequest, isSynchronizeOnSession, setSynchronizeOnSession
 
Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator
applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseExpiresHeader
 
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, isContextRequired, setServletContext
 
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NEW_FOLDER_VIEW

public static final java.lang.String NEW_FOLDER_VIEW
See Also:
Constant Field Values

RENAME_FOLDER_FILE_VIEW

public static final java.lang.String RENAME_FOLDER_FILE_VIEW
See Also:
Constant Field Values

DELETE_FOLDERFILE_VIEW

public static final java.lang.String DELETE_FOLDERFILE_VIEW
See Also:
Constant Field Values

MAIN_VIEW

public static final java.lang.String MAIN_VIEW
See Also:
Constant Field Values

EDIT_FILE_VIEW

public static final java.lang.String EDIT_FILE_VIEW
See Also:
Constant Field Values

SERVLET_PATH

public static final java.lang.String SERVLET_PATH
See Also:
Constant Field Values
Constructor Detail

ManageFilesFormController

public ManageFilesFormController()
Method Detail

formBackingObject

protected java.lang.Object formBackingObject(javax.servlet.http.HttpServletRequest request)
                                      throws java.lang.Exception
This method will create the command object and set it in its initial state. This method is called before the user is directed to the first page of the wizard

Overrides:
formBackingObject in class org.springframework.web.servlet.mvc.AbstractFormController
Parameters:
request - HttpServletRequest
Returns:
Object
Throws:
java.lang.Exception

onSubmit

protected org.springframework.web.servlet.ModelAndView onSubmit(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                java.lang.Object command,
                                                                org.springframework.validation.BindException errors)
                                                         throws java.lang.Exception
Submit callback with all parameters. Called in case of submit without errors reported by the registered validator, or on every submit if no validator.

Overrides:
onSubmit in class org.springframework.web.servlet.mvc.SimpleFormController
Parameters:
request - HttpServletRequest
response - HttpServletResponse
command - Object
errors - BindException
Returns:
ModelAndView
Throws:
java.lang.Exception

handleClick

protected org.springframework.web.servlet.ModelAndView handleClick(java.lang.String action,
                                                                   java.lang.String path,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response,
                                                                   java.lang.Object command,
                                                                   org.springframework.validation.BindException errors)
                                                            throws java.lang.Exception
This method handles submit action requested by clicking icons.

Parameters:
action - String
path - String
request - HttpServletRequest
response - HttpServletResponse
command - Object
errors - BindException
Returns:
ModelAndView
Throws:
java.lang.Exception

handleCreate

protected org.springframework.web.servlet.ModelAndView handleCreate(javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response,
                                                                    java.lang.Object command,
                                                                    org.springframework.validation.BindException errors)
                                                             throws java.lang.Exception
This method handles create action.

Parameters:
request - HttpServletRequest
response - HttpServletResponse
command - Object
errors - BindException
Returns:
ModelAndView
Throws:
java.lang.Exception

handleDelete

protected org.springframework.web.servlet.ModelAndView handleDelete(javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response,
                                                                    java.lang.Object command,
                                                                    org.springframework.validation.BindException errors)
                                                             throws java.lang.Exception
This method handles delete action.

Parameters:
request - HttpServletRequest
response - HttpServletResponse
command - Object
errors - BindException
Returns:
ModelAndView
Throws:
java.lang.Exception

handleRename

protected org.springframework.web.servlet.ModelAndView handleRename(javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response,
                                                                    java.lang.Object command,
                                                                    org.springframework.validation.BindException errors)
                                                             throws java.lang.Exception
handles rename action

Parameters:
request - HttpServletRequest
response - HttpServletResponse
command - Object
errors - BindException
Returns:
ModelAndView
Throws:
java.lang.Exception

handleSaveFile

protected org.springframework.web.servlet.ModelAndView handleSaveFile(javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response,
                                                                      java.lang.Object command,
                                                                      org.springframework.validation.BindException errors)
                                                               throws java.lang.Exception
Saves edited text file

Parameters:
request - HttpServletRequest
response - HttpServletResponse
command - Object
errors - BindException
Returns:
ModelAndView
Throws:
java.lang.Exception

handleCancel

protected org.springframework.web.servlet.ModelAndView handleCancel(javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response,
                                                                    java.lang.Object command,
                                                                    org.springframework.validation.BindException errors)
                                                             throws java.lang.Exception
This method handles cancel action and redirects to manage file page.

Parameters:
request - HttpServletRequest
response - HttpServletResponse
command - Object
errors - BindException
Returns:
ModelAndView
Throws:
java.lang.Exception

setXslTemplate

public void setXslTemplate(java.lang.String xslTemplate)
set by spring

Parameters:
xslTemplate - String

setEditableFileTypes

public void setEditableFileTypes(java.util.List editableFileTypes)

getXslTemplate

public java.lang.String getXslTemplate()

getEditableFileTypes

public java.util.List getEditableFileTypes()

getFolderRoot

public Folder getFolderRoot()
used by test case

Returns:
Folder

getPrivateSuccessView

public java.lang.String getPrivateSuccessView()

setPrivateSuccessView

public void setPrivateSuccessView(java.lang.String privateSuccessView)