com.atlassian.confluence.importexport.actions
Class AbstractImportAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.importexport.actions.AbstractBackupRestoreAction
              extended by com.atlassian.confluence.importexport.actions.AbstractImportAction
All Implemented Interfaces:
WebInterface, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable
Direct Known Subclasses:
AbstractFileRestoreAction

public abstract class AbstractImportAction
extends AbstractBackupRestoreAction

See Also:
Serialized Form

Field Summary
static String RESTORE_DIR
           
 
Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
AbstractImportAction()
           
 
Method Summary
protected abstract  DefaultImportContext createImportContext(ExportDescriptor exportDescriptor)
           
 String execute()
           
protected  ConfluenceIndexManager getIndexManager()
           
 String getLocalFileName()
           
protected abstract  File getRestoreFile()
           
protected  File getRestoreFileFromFileSystem()
           
protected  File getRestoreFileFromUpload()
          retrieves restore file from upload
 com.atlassian.core.task.longrunning.LongRunningTask getTask()
           
 String getTaskId()
           
 boolean isBuildIndex()
           
protected  boolean isImportAllowed(ExportDescriptor exportDescriptor)
          Override if you want to prohibit certain types of export zips from being imported
 void setBuildIndex(boolean buildIndex)
           
 void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)
           
 void setIndexManager(ConfluenceIndexManager indexManager)
           
 void setLocalFileName(String localFileName)
           
 
Methods inherited from class com.atlassian.confluence.importexport.actions.AbstractBackupRestoreAction
getBuildInformation, getFilesInRestoreFolder, getImportExportManager, getSystemFileSeparator, isPermitted, isSynchronous, setImportExportManager, setSynchronous
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setUserAccessor, setWebInterfaceManager
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, 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.confluence.validation.MessageHolderAware
validate
 

Field Detail

RESTORE_DIR

public static final String RESTORE_DIR
See Also:
Constant Field Values
Constructor Detail

AbstractImportAction

public AbstractImportAction()
Method Detail

execute

public String execute()
               throws Exception
Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class com.opensymphony.xwork.ActionSupport
Throws:
Exception

getTask

public final com.atlassian.core.task.longrunning.LongRunningTask getTask()

getRestoreFileFromUpload

protected File getRestoreFileFromUpload()
                                 throws ImportExportException
retrieves restore file from upload

Throws:
ImportExportException

getRestoreFileFromFileSystem

protected File getRestoreFileFromFileSystem()
                                     throws ImportExportException
Throws:
ImportExportException

isImportAllowed

protected boolean isImportAllowed(ExportDescriptor exportDescriptor)
                           throws ImportExportException,
                                  UnexpectedImportZipFileContents
Override if you want to prohibit certain types of export zips from being imported

Throws:
ImportExportException
UnexpectedImportZipFileContents

getLocalFileName

public String getLocalFileName()

setLocalFileName

public void setLocalFileName(String localFileName)

isBuildIndex

public boolean isBuildIndex()

setBuildIndex

public void setBuildIndex(boolean buildIndex)

setEventPublisher

public final void setEventPublisher(com.atlassian.event.api.EventPublisher eventPublisher)

setIndexManager

public void setIndexManager(ConfluenceIndexManager indexManager)

getTaskId

public String getTaskId()

getIndexManager

protected ConfluenceIndexManager getIndexManager()

createImportContext

protected abstract DefaultImportContext createImportContext(ExportDescriptor exportDescriptor)
                                                     throws ImportExportException,
                                                            UnexpectedImportZipFileContents
Throws:
ImportExportException
UnexpectedImportZipFileContents

getRestoreFile

protected abstract File getRestoreFile()
                                throws ImportExportException
Throws:
ImportExportException


Copyright © 2003-2012 Atlassian. All Rights Reserved.