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

java.lang.Object
  extended by webwork.action.ActionSupport
      extended by com.atlassian.jira.action.JiraActionSupport
          extended by com.atlassian.jira.web.action.JiraWebActionSupport
              extended by com.atlassian.jira.web.action.JiraWizardActionSupport
                  extended by com.atlassian.jira.web.action.util.BaseImporter
All Implemented Interfaces:
ErrorCollection, I18nHelper, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware
Direct Known Subclasses:
CsvImporter, FogBugzImport

public abstract class BaseImporter
extends JiraWizardActionSupport

See Also:
Serialized Form

Field Summary
 
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 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, ApplicationProperties applicationProperties, UserUtil userUtil)
           
 
Method Summary
protected  void acceptWebParameters()
           
 boolean doesImportExceedUserLimit()
           
 String doImport()
          Do the actual import
abstract  String doSettings()
           
 String doViewLogs()
          View the logs while the importer is still going on
 String getAbortButton()
           
 JiraAuthenticationContext getAuthenticationContext()
           
 org.apache.commons.configuration.FileConfiguration getConfigFile()
           
 String getConfigFileLocation()
           
 String getImportActionName()
           
 JiraDataImporter getImporter()
           
 String getImportLocation()
           
 long getRefreshInterval()
           
abstract  String getTitle()
           
 int getTotalSteps()
           
 Set getUnknownUsers()
           
 boolean isExternalUserManagementEnabled()
           
 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, isFinishClicked, isNextClicked, isPreviousClicked, setCurrentStep, setFinishButton, setSubmitBtn
 
Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
addErrorCollection, forceRedirect, getAssignableUsers, getAssignableUsers, getCachedGroups, getComponentManager, getConstantsManager, getDateFormat, getDateTimeFormat, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getJiraServiceContext, getLanguage, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRedirect, getRemoteUser, getReturnUrl, getSearchSortReverseDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getText, getTimeFormat, getUserFullName, getVersionManager, getWebworkStack, getWebworkStack, htmlEncode, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isSystemAdministrator, isUserExists, 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, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isEnterprise, isIndexing, isProfessional, isProfessionalOrEnterprise, isStandard, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doDefault, doValidation, getErrorMessages, getErrors, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, 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
 

Constructor Detail

BaseImporter

public BaseImporter(JiraAuthenticationContext authenticationContext,
                    ApplicationProperties applicationProperties,
                    UserUtil userUtil)
Method Detail

acceptWebParameters

protected void acceptWebParameters()

doSettings

public abstract String doSettings()
                           throws Exception
Throws:
Exception

doImport

public String doImport()
Do the actual import

Returns:
view name

doViewLogs

public String doViewLogs()
View the logs while the importer is still going on

Returns:
view name

doesImportExceedUserLimit

public boolean doesImportExceedUserLimit()

isExternalUserManagementEnabled

public boolean isExternalUserManagementEnabled()

getAuthenticationContext

public JiraAuthenticationContext getAuthenticationContext()

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)

getUnknownUsers

public Set getUnknownUsers()


Copyright © 2002-2009 Atlassian. All Rights Reserved.