org.dspace.app.webui.submit.step

Class JSPUploadStep

java.lang.Object

org.dspace.app.webui.submit.JSPStep

org.dspace.app.webui.submit.step.JSPUploadStep

Direct Known Subclasses:

JSPUploadWithEmbargoStep

public class JSPUploadStep
extends JSPStep

Upload step for DSpace JSP-UI. Handles the pages that revolve around uploading files (and verifying a successful upload) for an item being submitted into DSpace.

This JSPStep class works with the SubmissionController servlet for the JSP-UI

The following methods are called in this order:

• Call doPreProcessing() method
• If showJSP() was specified from doPreProcessing(), then the JSP specified will be displayed
• If showJSP() was not specified from doPreProcessing(), then the doProcessing() method is called and the step completes immediately
• Call doProcessing() method on appropriate AbstractProcessingStep after the user returns from the JSP, in order to process the user input
• Call doPostProcessing() method to determine if more user interaction is required, and if further JSPs need to be called.
• If there are more "pages" in this step then, the process begins again (for the new page).
• Once all pages are complete, control is forwarded back to the SubmissionController, and the next step is called.

Version:

$Revision$

Author:

Tim Donohue

See Also:

SubmissionController, JSPStep, UploadStep

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	UPLOAD_ERROR_JSP JSP to show any upload errors *
protected static java.lang.String	VIRUS_CHECKER_ERROR_JSP JSP to show any upload errors *
protected static java.lang.String	VIRUS_ERROR_JSP JSP to show any upload errors *

Fields inherited from class org.dspace.app.webui.submit.JSPStep

NO_JSP

Constructor Summary

Constructors

Constructor and Description
JSPUploadStep()

Method Summary

Methods

Modifier and Type	Method and Description
void	doPostProcessing(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo, int status) Do any post-processing after the step's backend processing occurred (in the doProcessing() method).
void	doPreProcessing(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo) Do any pre-processing to determine which JSP (if any) is used to generate the UI for this step.
java.lang.String	getReviewJSP(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo) Return the URL path (e.g.
protected void	showChooseFile(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo) Show the page which allows the user to choose another file to upload
protected void	showFileDescription(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo) Show the page which allows the user to edit the description of already uploaded files
protected void	showGetFileFormat(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo) Show the page which allows the user to change the format of the file that was just uploaded
protected void	showUploadFileList(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo, boolean justUploaded, boolean showChecksums) Show the page which lists all the currently uploaded files
protected void	showUploadPage(Context context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SubmissionInfo subInfo, boolean justUploaded) Display the appropriate upload page in the file upload sequence.

Methods inherited from class java.lang.Object

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

Field Detail

UPLOAD_ERROR_JSP

protected static final java.lang.String UPLOAD_ERROR_JSP

JSP to show any upload errors *

See Also:

Constant Field Values

VIRUS_CHECKER_ERROR_JSP

protected static final java.lang.String VIRUS_CHECKER_ERROR_JSP

JSP to show any upload errors *

See Also:

Constant Field Values

VIRUS_ERROR_JSP

protected static final java.lang.String VIRUS_ERROR_JSP

JSP to show any upload errors *

See Also:

Constant Field Values

Constructor Detail

JSPUploadStep

public JSPUploadStep()

Method Detail

doPreProcessing

public void doPreProcessing(Context context,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   SubmissionInfo subInfo)
                     throws javax.servlet.ServletException,
                            java.io.IOException,
                            java.sql.SQLException,
                            AuthorizeException

Do any pre-processing to determine which JSP (if any) is used to generate the UI for this step. This method should include the gathering and validating of all data required by the JSP. In addition, if the JSP requires any variable to passed to it on the Request, this method should set those variables.

If this step requires user interaction, then this method must call the JSP to display, using the "showJSP()" method of the JSPStepManager class.

If this step doesn't require user interaction OR you are solely using Manakin for your user interface, then this method may be left EMPTY, since all step processing should occur in the doProcessing() method.

Specified by:

doPreProcessing in class JSPStep

Parameters:

context - current DSpace context

request - current servlet request object

response - current servlet response object

subInfo - submission info object

Throws:

javax.servlet.ServletException

java.io.IOException

java.sql.SQLException

AuthorizeException

doPostProcessing

public void doPostProcessing(Context context,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    SubmissionInfo subInfo,
                    int status)
                      throws javax.servlet.ServletException,
                             java.io.IOException,
                             java.sql.SQLException,
                             AuthorizeException

Do any post-processing after the step's backend processing occurred (in the doProcessing() method).

It is this method's job to determine whether processing completed successfully, or display another JSP informing the users of any potential problems/errors.

If this step doesn't require user interaction OR you are solely using Manakin for your user interface, then this method may be left EMPTY, since all step processing should occur in the doProcessing() method.

Specified by:

doPostProcessing in class JSPStep

Parameters:

context - current DSpace context

request - current servlet request object

response - current servlet response object

subInfo - submission info object

status - any status/errors reported by doProcessing() method

Throws:

javax.servlet.ServletException

java.io.IOException

java.sql.SQLException

AuthorizeException

showUploadPage

protected void showUploadPage(Context context,
                  javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response,
                  SubmissionInfo subInfo,
                  boolean justUploaded)
                       throws java.sql.SQLException,
                              javax.servlet.ServletException,
                              java.io.IOException

Display the appropriate upload page in the file upload sequence. Which page this is depends on whether the user has uploaded any files in this item already.

Parameters:

context - the DSpace context object

request - the request object

response - the response object

subInfo - the SubmissionInfo object

justUploaded - true, if the user just finished uploading a file

Throws:

java.sql.SQLException

javax.servlet.ServletException

java.io.IOException

showChooseFile

protected void showChooseFile(Context context,
                  javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response,
                  SubmissionInfo subInfo)
                       throws java.sql.SQLException,
                              javax.servlet.ServletException,
                              java.io.IOException

Show the page which allows the user to choose another file to upload

Parameters:

context - current DSpace context

request - the request object

response - the response object

subInfo - the SubmissionInfo object

Throws:

java.sql.SQLException

javax.servlet.ServletException

java.io.IOException

showUploadFileList

protected void showUploadFileList(Context context,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      SubmissionInfo subInfo,
                      boolean justUploaded,
                      boolean showChecksums)
                           throws java.sql.SQLException,
                                  javax.servlet.ServletException,
                                  java.io.IOException

Show the page which lists all the currently uploaded files

Parameters:

context - current DSpace context

request - the request object

response - the response object

subInfo - the SubmissionInfo object

justUploaded - pass in true if the user just successfully uploaded a file

showChecksums - pass in true if checksums should be displayed

Throws:

java.sql.SQLException

javax.servlet.ServletException

java.io.IOException

showGetFileFormat

protected void showGetFileFormat(Context context,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     SubmissionInfo subInfo)
                          throws java.sql.SQLException,
                                 javax.servlet.ServletException,
                                 java.io.IOException

Show the page which allows the user to change the format of the file that was just uploaded

Parameters:

context - context object

request - the request object

response - the response object

subInfo - the SubmissionInfo object

Throws:

java.sql.SQLException

javax.servlet.ServletException

java.io.IOException

showFileDescription

protected void showFileDescription(Context context,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       SubmissionInfo subInfo)
                            throws java.sql.SQLException,
                                   javax.servlet.ServletException,
                                   java.io.IOException

Show the page which allows the user to edit the description of already uploaded files

Parameters:

context - context object

request - the request object

response - the response object

subInfo - the SubmissionInfo object

Throws:

java.sql.SQLException

javax.servlet.ServletException

java.io.IOException

getReviewJSP

public java.lang.String getReviewJSP(Context context,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            SubmissionInfo subInfo)

Return the URL path (e.g. /submit/review-metadata.jsp) of the JSP which will review the information that was gathered in this Step.

This Review JSP is loaded by the 'Verify' Step, in order to dynamically generate a submission verification page consisting of the information gathered in all the enabled submission steps.

Specified by:

getReviewJSP in class JSPStep

Parameters:

context - current DSpace context

request - current servlet request object

response - current servlet response object

subInfo - submission info object