fr.onema.sispea.struts.exchange.action

Class FileDownloadAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

fr.onema.sispea.struts.AbstractSispeaAction

fr.onema.sispea.struts.exchange.action.FileDownloadAction

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

Direct Known Subclasses:

DownloadAction, DownloadPreparedExportAction, InitFileDownloadAction

public class FileDownloadAction
extends AbstractSispeaAction

This action handles the file downloading. It allows the end user to download data and referential.

Author:

CS

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	chosenCompetences the chosen competences
protected List<CompetenceDto>	competences the competence list
protected String	contentDisposition The name of the returned file.
protected String	contentType The content type (MIME type).
protected String	downloadFormat file format to download
static String[]	EMPTY_STRING_ARRAY
protected Integer	exerciseId the selected exercise id
protected Map<Integer,String>	exerciseList
protected ExerciseService	exerciseService
protected TerritoryDto	extractTerritory territory to extract
protected Integer	extractTerritoryId territory id to extract
protected FileExchangeService	fileExchangeService
protected String	fileName The filename.
protected Long	fileSize The file size.
protected FileType	fileType file type
protected InputStream	inputStream The CSV input stream.
protected ReferentialService	referentialService
protected Integer	selectionId Teritory Id selected returned from "Enhance my selections"
protected List<TerritoryDto>	userSelection the user selected territories
protected Boolean	withData Flag to note if the data should be included in downloaded file
protected Boolean	withReferential Flag to note if the referential should be included in downloaded file

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
FileDownloadAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkCompetence() check competence params
protected void	checkUsersSelections() check user's selections and fill corresponding list
protected String	doExecute() This method is called by the execute method.
List<AvailableDownload>	getAvailableDownloads()
Integer	getBackPageId()
String[]	getChosenCompetences()
List<CompetenceDto>	getCompetences()
String	getContentDisposition()
String	getContentType()
String	getDownloadFormat()
Integer	getExerciseId()
Map<Integer,String>	getExerciseList()
TerritoryDto	getExtractTerritory()
Integer	getExtractTerritoryId()
String	getFileName()
Long	getFileSize()
FileType	getFileType()
InputStream	getInputStream()
Map<String,String>	getSelectedTerritories()
Integer	getSelectionId()
List<TerritoryDto>	getUserSelection()
Boolean	getWithData()
Boolean	getWithReferential()
protected void	loadAvailableDownloads(UserDto pUser) This method fetches the available downloads from the database.
protected void	loadExcerciseList()
protected void	manageDefaultValues() Manage the default values to display on jsp
void	setChosenCompetences(String[] pChosenCompetences)
void	setCompetences(List<CompetenceDto> pCompetences)
void	setContentDisposition(String pContentDisposition)
void	setContentType(String pContentType)
void	setDownloadFormat(String pDownloadFormat)
void	setExerciseId(Integer pExerciseId)
void	setExtractTerritory(TerritoryDto pExtractTerritory)
void	setExtractTerritoryId(Integer pExtractTerritoryId)
void	setFileName(String pFileName)
void	setFileSize(Long pFileSize)
void	setFileType(FileType pFileType)
void	setInputStream(InputStream pInputStream)
void	setSelectionId(Integer pSelectionId)
void	setUserSelection(List<TerritoryDto> pUserSelection)
void	setWithData(Boolean pWithData)
void	setWithReferential(Boolean pWithReferential)

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

buildMenu, checkIfUserCanViewDashBoard, checkRight, 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

EMPTY_STRING_ARRAY

public static final String[] EMPTY_STRING_ARRAY

fileExchangeService

@Autowired
protected transient FileExchangeService fileExchangeService

exerciseService

@Autowired
protected transient ExerciseService exerciseService

referentialService

@Autowired
protected transient ReferentialService referentialService

extractTerritoryId

protected Integer extractTerritoryId

territory id to extract

extractTerritory

protected TerritoryDto extractTerritory

territory to extract

fileName

protected String fileName

The filename.

fileType

protected FileType fileType

file type

withData

protected Boolean withData

Flag to note if the data should be included in downloaded file

withReferential

protected Boolean withReferential

Flag to note if the referential should be included in downloaded file

competences

protected List<CompetenceDto> competences

the competence list

chosenCompetences

protected String[] chosenCompetences

the chosen competences

contentDisposition

protected String contentDisposition

The name of the returned file.

contentType

protected String contentType

The content type (MIME type).

fileSize

protected Long fileSize

The file size.

inputStream

protected transient InputStream inputStream

The CSV input stream.

downloadFormat

protected String downloadFormat

file format to download

exerciseId

protected Integer exerciseId

the selected exercise id

userSelection

protected List<TerritoryDto> userSelection

the user selected territories

selectionId

protected Integer selectionId

Teritory Id selected returned from "Enhance my selections"

exerciseList

protected Map<Integer,String> exerciseList

Constructor Detail

FileDownloadAction

public FileDownloadAction()

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

loadAvailableDownloads

protected void loadAvailableDownloads(UserDto pUser)
                               throws SispeaException

This method fetches the available downloads from the database. The downloads depend on the user rights.

Throws:

SispeaException

manageDefaultValues

protected void manageDefaultValues()

Manage the default values to display on jsp

checkCompetence

protected void checkCompetence()
                        throws SispeaException

check competence params

Throws:

SispeaException

checkUsersSelections

protected void checkUsersSelections()
                             throws SispeaException

check user's selections and fill corresponding list

Throws:

SispeaException

getSelectedTerritories

public Map<String,String> getSelectedTerritories()

Returns:

the list of user's selected territories

getExerciseList

public Map<Integer,String> getExerciseList()
                                    throws SispeaException

Returns:

the list of exercises

Throws:

SispeaException

getBackPageId

public Integer getBackPageId()

getExtractTerritory

public TerritoryDto getExtractTerritory()

setExtractTerritory

public void setExtractTerritory(TerritoryDto pExtractTerritory)

getContentType

public String getContentType()

setContentType

public void setContentType(String pContentType)

getFileSize

public Long getFileSize()

setFileSize

public void setFileSize(Long pFileSize)

getInputStream

public InputStream getInputStream()

setInputStream

public void setInputStream(InputStream pInputStream)

getDownloadFormat

public String getDownloadFormat()

setDownloadFormat

public void setDownloadFormat(String pDownloadFormat)

getFileName

public String getFileName()

setFileName

public void setFileName(String pFileName)

getWithData

public Boolean getWithData()

setWithData

public void setWithData(Boolean pWithData)

getWithReferential

public Boolean getWithReferential()

setWithReferential

public void setWithReferential(Boolean pWithReferential)

getCompetences

public List<CompetenceDto> getCompetences()

setCompetences

public void setCompetences(List<CompetenceDto> pCompetences)

getChosenCompetences

public String[] getChosenCompetences()

setChosenCompetences

public void setChosenCompetences(String[] pChosenCompetences)

getFileType

public FileType getFileType()

setFileType

public void setFileType(FileType pFileType)

getExerciseId

public Integer getExerciseId()

setExerciseId

public void setExerciseId(Integer pExerciseId)

getExtractTerritoryId

public Integer getExtractTerritoryId()

setExtractTerritoryId

public void setExtractTerritoryId(Integer pExtractTerritoryId)

getUserSelection

public List<TerritoryDto> getUserSelection()

setUserSelection

public void setUserSelection(List<TerritoryDto> pUserSelection)

getContentDisposition

public String getContentDisposition()

setContentDisposition

public void setContentDisposition(String pContentDisposition)

getAvailableDownloads

public List<AvailableDownload> getAvailableDownloads()

getSelectionId

public Integer getSelectionId()

setSelectionId

public void setSelectionId(Integer pSelectionId)

loadExcerciseList

protected void loadExcerciseList()
                          throws SispeaException

Throws:

SispeaException