fr.onema.sispea.struts.exchange.action

Class ValidateFileAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

fr.onema.sispea.struts.AbstractSispeaAction

fr.onema.sispea.struts.exchange.action.AbstractFileUploadAction

fr.onema.sispea.struts.exchange.action.ValidateFileAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, Serializable, org.apache.struts2.interceptor.ApplicationAware, org.apache.struts2.interceptor.ParameterAware, org.apache.struts2.interceptor.SessionAware

public class ValidateFileAction
extends AbstractFileUploadAction

This action validates the uploaded file. It allows the end user to upload data and referential. The validation process is asynchronous. Thus the action is not waiting for the validation process to end. The user will be notified by e-mail of the validation status.

Author:

CS

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Locale	DEFAULT_LOCALE
protected String	fileCaption The caption of the file entered by user.
protected boolean	fileValid Indicates whether the data of the uploaded file can be added to the db.
protected Collection<ExchangeMessageDto>	messages The messages returned from the file upload validation.
protected File	upload The uploaded file.
protected String	uploadContentType The content type of the uploaded file.
protected String	uploadFileName The name of the uploaded file.
protected boolean	validated Indicates whether the uploaded file has been submitted for validation.

Fields inherited from class fr.onema.sispea.struts.exchange.action.AbstractFileUploadAction

comment, fileExchangeService, originTypeId, overwriteData, preserveStatus, standardImport, statusId

Fields inherited from class fr.onema.sispea.struts.AbstractSispeaAction

application, configuration, formatDate, formatDateOnly, menu, nextPage, parameters, serviceMessages, session, sispeaSession, strutsMessages, submitValue, territoryService, userService

Fields inherited from class com.opensymphony.xwork2.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ValidateFileAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	doExecute() This method is called by the execute method.
String	getFileCaption()
Collection<ExchangeMessageDto>	getMessages()
File	getUpload()
String	getUploadContentType()
String	getUploadFileName()
boolean	isFileValid()
boolean	isValidated() Returns true if the uploaded file has been submitted for validation.
void	setFileCaption(String pFileCaption)
void	setUpload(File pUpload)
void	setUploadContentType(String pUploadContentType)
void	setUploadFileName(String pUploadFileName)

Methods inherited from class fr.onema.sispea.struts.exchange.action.AbstractFileUploadAction

checkRight, getComment, getOriginTypeId, getOriginTypesList, getOverwriteData, getPreserveStatus, getStandardImport, getStatusId, getStatusList, setComment, setOriginTypeId, setOverwriteData, setPreserveStatus, setStandardImport, setStatusId

Methods inherited from class fr.onema.sispea.struts.AbstractSispeaAction

buildMenu, checkIfUserCanViewDashBoard, checkUserRight, checkUserRight, checkUserRight, createMenu, doHandleException, doHandleSispeaException, execute, getApplication, getCurrentUser, getCurrentUserTerritory, getFormatDate, getFormatDateOnly, getMenu, getNextPage, getOption, getParameters, getSession, getSispeaSession, getSubmitValue, initSession, isEnglish, isFrench, isSpanish, logException, openMenu, removeSession, setApplication, setMenu, setNextPage, setParameters, setSession, setSubmitValue

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, doDefault, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOCALE

protected static final Locale DEFAULT_LOCALE

upload

protected File upload

The uploaded file.

uploadContentType

protected String uploadContentType

The content type of the uploaded file.

uploadFileName

protected String uploadFileName

The name of the uploaded file.

fileCaption

protected String fileCaption

The caption of the file entered by user.

validated

protected boolean validated

Indicates whether the uploaded file has been submitted for validation.

fileValid

protected boolean fileValid

Indicates whether the data of the uploaded file can be added to the db.

messages

protected Collection<ExchangeMessageDto> messages

The messages returned from the file upload validation.

Constructor Detail

ValidateFileAction

public ValidateFileAction()

Method Detail

doExecute

protected String doExecute()
                    throws Exception

Description copied from class: AbstractSispeaAction

This method is called by the execute method. It should implement the real processing of the action. To be overridden by the subclasses.

Specified by:

doExecute in class AbstractSispeaAction

Throws:

Exception

isValidated

public boolean isValidated()

Returns true if the uploaded file has been submitted for validation.

isFileValid

public boolean isFileValid()

getMessages

public Collection<ExchangeMessageDto> getMessages()

getUpload

public File getUpload()

setUpload

public void setUpload(File pUpload)

getUploadContentType

public String getUploadContentType()

setUploadContentType

public void setUploadContentType(String pUploadContentType)

getUploadFileName

public String getUploadFileName()

setUploadFileName

public void setUploadFileName(String pUploadFileName)

getFileCaption

public String getFileCaption()

setFileCaption

public void setFileCaption(String pFileCaption)