com.atlassian.confluence.importexport.actions
Class AbstractImportAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.importexport.actions.AbstractBackupRestoreAction
              com.atlassian.confluence.importexport.actions.AbstractImportAction

All Implemented Interfaces:

WebInterface, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, java.io.Serializable

Direct Known Subclasses:

AbstractFileRestoreAction, ImportSnipSnapAction

public abstract class AbstractImportAction
extends AbstractBackupRestoreAction

See Also:

Serialized Form

Field Summary

protected com.atlassian.event.api.EventPublisher	eventPublisher
protected IndexRebuilder	indexRebuilder
static java.lang.String	RESTORE_DIR

Fields inherited from class com.atlassian.confluence.importexport.actions.AbstractBackupRestoreAction

importExportManager, synchronous

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, 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()
protected void	doRestore()
java.lang.String	execute()
java.lang.String	getLocalFileName()
protected java.io.File	getRestoreFileFromFileSystem()
protected java.io.File	getRestoreFileFromUpload() retrieves restore file from upload
com.atlassian.core.task.longrunning.LongRunningTask	getTask()
boolean	isBuildIndex()
protected boolean	isImportAllowed() 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	setIndexRebuilder(IndexRebuilder indexRebuilder)
void	setLocalFileName(java.lang.String localFileName)

Methods inherited from class com.atlassian.confluence.importexport.actions.AbstractBackupRestoreAction

getFilesInRestoreFolder, getSystemFileSeparator, isPermitted, isSynchronous, setImportExportManager, setSynchronous

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancelResult, getContext, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, 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, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, 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

Field Detail

RESTORE_DIR

public static final java.lang.String RESTORE_DIR

See Also:

Constant Field Values

eventPublisher

protected com.atlassian.event.api.EventPublisher eventPublisher

indexRebuilder

protected IndexRebuilder indexRebuilder

Constructor Detail

AbstractImportAction

public AbstractImportAction()

Method Detail

execute

public java.lang.String execute()
                         throws java.lang.Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

Throws:

java.lang.Exception

getTask

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

doRestore

protected void doRestore()
                  throws ImportExportException,
                         UnexpectedImportZipFileContents

Throws:

ImportExportException

UnexpectedImportZipFileContents

getRestoreFileFromUpload

protected java.io.File getRestoreFileFromUpload()
                                         throws ImportExportException

retrieves restore file from upload

Throws:

ImportExportException

getRestoreFileFromFileSystem

protected java.io.File getRestoreFileFromFileSystem()
                                             throws ImportExportException

Throws:

ImportExportException

isImportAllowed

protected boolean isImportAllowed()
                           throws ImportExportException,
                                  UnexpectedImportZipFileContents

Override if you want to prohibit certain types of export zips from being imported

Returns:

Throws:

ImportExportException

UnexpectedImportZipFileContents

getLocalFileName

public java.lang.String getLocalFileName()

setLocalFileName

public void setLocalFileName(java.lang.String localFileName)

isBuildIndex

public boolean isBuildIndex()

setBuildIndex

public void setBuildIndex(boolean buildIndex)

setEventPublisher

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

setIndexRebuilder

public void setIndexRebuilder(IndexRebuilder indexRebuilder)

createImportContext

protected abstract DefaultImportContext createImportContext()
                                                     throws ImportExportException,
                                                            UnexpectedImportZipFileContents

Throws:

ImportExportException

UnexpectedImportZipFileContents