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, 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

Fields

Modifier and Type	Field and Description
static String	RESTORE_DIR

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

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, 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

Constructors

Constructor and Description
AbstractImportAction()

Method Summary

Modifier and Type	Method and Description
protected abstract DefaultImportContext	createImportContext(ExportDescriptor exportDescriptor)
protected com.atlassian.core.task.longrunning.LongRunningTask	createImportTask(DefaultImportContext context)
String	execute()
protected IndexManager	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(IndexManager indexManager)
void	setLocalFileName(String localFileName)
void	setLongRunningTaskManager(LongRunningTaskManagerInternal longRunningTaskManager)
void	setTaskId(String taskId)

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

getBuildInformation, getFilenames, getFilesInRestoreFolder, getFullExportBackwardsCompatibility, getImportExportManager, getMinimumFullImportVersion, getMinimumSpaceImportVersion, getSystemFileSeparator, isPermitted, isSynchronous, setImportExportManager, setSynchronous

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, withServletRequestSupplier

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

createImportTask

protected com.atlassian.core.task.longrunning.LongRunningTask createImportTask(DefaultImportContext context)

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(IndexManager indexManager)

setLongRunningTaskManager

public void setLongRunningTaskManager(LongRunningTaskManagerInternal longRunningTaskManager)

getTaskId

public String getTaskId()

setTaskId

public void setTaskId(String taskId)

getIndexManager

protected IndexManager getIndexManager()

createImportContext

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

Throws:

ImportExportException

UnexpectedImportZipFileContents

getRestoreFile

protected abstract File getRestoreFile()
                                throws ImportExportException

Throws:

ImportExportException