com.atlassian.jira.web.action.util
Class BaseImporter

java.lang.Object
  webwork.action.ActionSupport
      com.atlassian.jira.action.JiraActionSupport
          com.atlassian.jira.web.action.JiraWebActionSupport
              com.atlassian.jira.web.action.JiraWizardActionSupport
                  com.atlassian.jira.web.action.util.BaseImporter

All Implemented Interfaces:

webwork.action.Action, webwork.action.CommandDriven, ErrorCollection, I18nHelper, webwork.action.IllegalArgumentAware, Serializable

Direct Known Subclasses:

CsvImporter, FogBugzImport, VisualInterceptImport

public abstract class BaseImporter

extends JiraWizardActionSupport

See Also:

Serialized Form

Field Summary

protected String	abortButton
protected JiraAuthenticationContext	authenticationContext
protected org.apache.commons.configuration.FileConfiguration	configFile
protected String	configFileLocation
protected String	importLocation
protected long	refreshInterval

Fields inherited from class com.atlassian.jira.web.action.JiraWizardActionSupport

currentStep, finishButton, submitBtn

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, savedFilters, selectedProject

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface com.atlassian.jira.util.I18nHelper

DEFAULT_RESOURCE_BUNDLE

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

BaseImporter(JiraAuthenticationContext authenticationContext)

Method Summary

String	doImport() Do the actual import
abstract String	doSettings()
String	doViewLogs() View the logs while the importer is still going on
String	getAbortButton()
org.apache.commons.configuration.FileConfiguration	getConfigFile()
String	getConfigFileLocation()
String	getImportActionName()
JiraDataImporter	getImporter()
String	getImportLocation()
long	getRefreshInterval()
abstract String	getTitle()
int	getTotalSteps()
void	setAbortButton(String abortButton)
void	setConfigFile(org.apache.commons.configuration.FileConfiguration configFile)
void	setConfigFileLocation(String configFileLocation)
void	setImporter(JiraDataImporter bean)
void	setImportLocation(String importLocation)
void	setRefreshInterval(long refreshInterval)
protected void	validateFile(File file, String fieldId)

Methods inherited from class com.atlassian.jira.web.action.JiraWizardActionSupport

doExecute, getCurrentStep, getFinishButton, getSubmitBtn, isButtonClickedByName, isButtonClickedByValue, isEnterprise, isFinishClicked, isNextClicked, isPreviousClicked, setCurrentStep, setFinishButton, setSubmitBtn

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addErrorCollection, forceRedirect, getAssignableUsers, getAssignableUsers, getCachedGroups, getCalendarTranslationFilenameForLanguage, getComponentManager, getConstantsManager, getDateFormat, getDateTimeFormat, getDefaultAssignee, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getLanguage, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRedirect, getRemoteUser, getReturnUrl, getSavedFilters, getSelectedProject, getText, getTimeFormat, getUserFullName, getVersionManager, isDefaultAssignee, isDefaultAssignee, isHasCalendarTranslationForLanguage, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, processDefaultAssignee, processDefaultAssignee, processDefaultAssignee, setReturnUrl, setSelectedProjectId

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getApplicationProperties, getDefaultResourceBundle, getDelegator, getJiraLocaleUtils, getLocale, getResult, getText, getText, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, isProfessional

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, doValidation, getErrorMessages, getErrors, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

setCommand

Field Detail

importLocation

protected String importLocation

configFileLocation

protected String configFileLocation

configFile

protected org.apache.commons.configuration.FileConfiguration configFile

abortButton

protected String abortButton

refreshInterval

protected long refreshInterval

authenticationContext

protected final JiraAuthenticationContext authenticationContext

Constructor Detail

BaseImporter

public BaseImporter(JiraAuthenticationContext authenticationContext)

Method Detail

doSettings

public abstract String doSettings()
                           throws Exception

Throws:

Exception

doImport

public String doImport()
                throws Exception

Do the actual import

Throws:

Exception

doViewLogs

public String doViewLogs()
                  throws Exception

View the logs while the importer is still going on

Throws:

Exception

getTitle

public abstract String getTitle()

getImportActionName

public String getImportActionName()

getImporter

public JiraDataImporter getImporter()

setImporter

public void setImporter(JiraDataImporter bean)

validateFile

protected void validateFile(File file,
                            String fieldId)

getConfigFileLocation

public String getConfigFileLocation()

setConfigFileLocation

public void setConfigFileLocation(String configFileLocation)

getImportLocation

public String getImportLocation()

setImportLocation

public void setImportLocation(String importLocation)

getTotalSteps

public int getTotalSteps()

Specified by:

getTotalSteps in class JiraWizardActionSupport

getAbortButton

public String getAbortButton()

setAbortButton

public void setAbortButton(String abortButton)

getRefreshInterval

public long getRefreshInterval()

setRefreshInterval

public void setRefreshInterval(long refreshInterval)

getConfigFile

public org.apache.commons.configuration.FileConfiguration getConfigFile()

setConfigFile

public void setConfigFile(org.apache.commons.configuration.FileConfiguration configFile)