org.kuali.rice.krad.labs.fileUploads

Class XmlIngesterController

java.lang.Object

org.kuali.rice.krad.web.controller.UifControllerBase

org.kuali.rice.krad.labs.fileUploads.XmlIngesterController

@Controller
@RequestMapping(value="/ingester")
public class XmlIngesterController
extends UifControllerBase

Controller for the XML Ingester View

Displays the initial Ingester view page and processes file upload requests.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

Constructors

Constructor and Description
XmlIngesterController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	close(XmlIngesterForm ingesterForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected int	collectIngestionMessages(List<XmlDocCollection> collections, boolean txFailed) loop through the results, returns the number of successfully processed files
protected List<XmlDocCollection>	copyInputFiles(List<org.springframework.web.multipart.MultipartFile> fileList, List<File> tempFiles) Copies the MultipartFiles into an XmlDocCollection list
protected XmlIngesterForm	createInitialForm() Invoked to create a new form instance for the request before it is passed to the Binder/BeanWrapper.
protected int	ingestFiles(List<XmlDocCollection> collections) Ingests the list of files into the system
org.springframework.web.servlet.ModelAndView	start(UifFormBase form)
org.springframework.web.servlet.ModelAndView	upload(XmlIngesterForm ingesterForm, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.kuali.rice.krad.web.controller.UifControllerBase

addBlankLine, addFileUploadLine, addLine, back, cancel, checkForm, closeEditLineDialog, defaultMapping, deleteFileUploadLine, deleteLine, editLine, getCollectionControllerService, getControllerService, getFileControllerService, getFileFromLine, getMessageView, getModelAndView, getModelAndView, getModelAndView, getModelAndViewService, getModelAndViewWithInit, getModelAndViewWithInit, getNavigationControllerService, getQueryControllerService, getRefreshControllerService, getSaveControllerService, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, refresh, retrieveCollectionPage, retrieveEditLineDialog, returnToHub, returnToPrevious, save, saveField, saveLine, sessionTimeout, setCollectionControllerService, setControllerService, setFileControllerService, setModelAndViewService, setNavigationControllerService, setQueryControllerService, setRefreshControllerService, setSaveControllerService, showDialog, tableJsonRetrieval

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlIngesterController

public XmlIngesterController()

Method Detail

createInitialForm

protected XmlIngesterForm createInitialForm()

Description copied from class: UifControllerBase

Invoked to create a new form instance for the request before it is passed to the Binder/BeanWrapper.

Specified by:

createInitialForm in class UifControllerBase

Returns:

UifFormBase instance that will be used for data binding and backing the view.

See Also:

org.kuali.rice.krad.web.controller.UifControllerBase#createInitialForm(javax.servlet.http.HttpServletRequest)

start

@RequestMapping(params="methodToCall=start")
public org.springframework.web.servlet.ModelAndView start(UifFormBase form)

Overrides:

start in class UifControllerBase

See Also:

ControllerService.start(org.kuali.rice.krad.web.form.UifFormBase)

upload

@RequestMapping(method=POST,
                params="methodToCall=upload")
public org.springframework.web.servlet.ModelAndView upload(@ModelAttribute(value="KualiForm")
                                                                 XmlIngesterForm ingesterForm,
                                                                 org.springframework.validation.BindingResult result,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)

copyInputFiles

protected List<XmlDocCollection> copyInputFiles(List<org.springframework.web.multipart.MultipartFile> fileList,
                                    List<File> tempFiles)

Copies the MultipartFiles into an XmlDocCollection list

Reads each of the input files into temporary files to get File reference needed to create FileXmlDocCollection objects. Also verifies that only .xml or .zip files are to be processed.

Parameters:

fileList - list of MultipartFiles selected for ingestion

tempFiles - temporary files used to get File reference

Returns:

uploaded files in a List of XmlDocCollections

ingestFiles

protected int ingestFiles(List<XmlDocCollection> collections)

Ingests the list of files into the system

Parameters:

collections - xml documents to be ingested

Returns:

the number of files successfully ingested

collectIngestionMessages

protected int collectIngestionMessages(List<XmlDocCollection> collections,
                           boolean txFailed)

loop through the results, returns the number of successfully processed files

Also collects the error messages for each doc

Parameters:

collections - the list of processed documents

txFailed - flag whether upload contained errors

Returns:

the number of files successfully ingested

close

@RequestMapping(method=POST,
                params="methodToCall=close")
public org.springframework.web.servlet.ModelAndView close(@ModelAttribute(value="KualiForm")
                                                                XmlIngesterForm ingesterForm,
                                                                org.springframework.validation.BindingResult result,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response)