com.atlassian.confluence.upgrade

Interface BackupSupport

All Known Implementing Classes:

AbstractConstraintCreationUpgradeTask, AbstractDeferredRunUpgradeTask, AbstractPageTemplateMigrationUpgradeTask, AbstractUpgradeTask, AbstractUserMappingUpgradeTask, AddHibernateVersionColumnUpgradeTask, AddSpacePermissionSubjectColumnUpgradeTask, AddSpaceStatusColumnUpgradeTask, AddUniqueAttachmentIdConstraintToAttachmentDataUpgradeTask, AtlassianUserToEmbeddedCrowdConfigurationUpgradeTask, AttachmentContentStatusUpgradeTask, AttachmentLabellingUpgradeTask, AttachmentToCeoConversionUpgradeTask, BandanaKeyUniqueConstraintUpgradeTask, ConditionallyEnableMailArchivePluginUpgradeTask, ContainedCustomContentEntityObjectUpgradeTask, ContentIndexUpgradeTask, ContentParentTypeFixingUpgradeTask, ContentPermissionConstraintsUpgradeTask, ContentPermissionUserDeduplicationUpgradeTask, ContentTypeIndexUpgradeTask, ConvertToRelativeLinksUpgradeTask, CorrectPNGImageAttachmentMimeTypeUpgradeTask, CrowdUsersUserMappingUpgradeTask, DefaultSpaceContentPageLayoutsUpgradeTask, DefaultSpaceContentToPageTemplateUpgradeTask, DeferredMacroExecutionUpgradeTask, DeleteDidYouMeanIndexFolderUpgradeTask, DisableConfluenceInvitePluginUpgradeTask, DropContentLockTableUpgradeTask, DropSpaceGroupTablesUpgradeTask, EhCacheConfigMigrationUpgradeTask, EmbeddedCrowdAttributeMappingUpgradeTask, EmbeddedCrowdInitUpgradeTask, EmbeddedCrowdMembershipAggregationUpgradeTask, EmbeddedCrowdPropertySetFactoryMigrationUpgradeTask, EmbeddedCrowdSchemaUpgradeTask, EmbeddedCrowdSynchronisationUpgradeTask, GenericContentPropertiesUpgradeTask, InitialiseIndexJournalStateUpgradeTask, InstallationDateUpgradeTask, JiraIssueMacroServerParamsUpgradeTask, LikesDanglingFKCleanupUpgradeTask, LikesSqlConstraintsUpgradeTask, LoginInfoDuplicateEntryRemovalUpgradeTask, LowerCaseUsernameReferencesUpgradeTask, MailConvertToCustomContentUpgradeTask, MailServerTimeoutUpgradeTask, MailServerUpgradeTask, MigrateIndexTaskQueueToJournalUpgradeTask, MigrateMailArchiveConfigurationUpgradeTask, MigrateOndemandDocThemeCustomizations, MsSqlServerAoUpgradeTask, NewColourUpgradeTask, NotificationPageColumnUpgradeTask, OnDemandSpacePermissionsDefaultUpgradeTask, PageTemplateWikiToXhtmlMigrationUpgradeTask, PageTemplateXhtmlRoundTripMigrationUpgradeTask, PersonalSpaceCreatorCheckUpgradeTask, RebuildFavouriteContentIndexUpgradeTask, RebuildIndexUpgradeTask, ReferencedUsersUserMappingUpgradeTask, RelationConstraintsPostSchemaUpgradeTask, RelationConstraintsPreSchemaUpgradeTask, RelationServiceUpgradeTask, RemoveConfluenceThreadDumpPluginUpgradeTask, RemoveEmailToPageWelcomeUpgradeTask, RemoveFixedWidthThemeUpgradeTask, RemovePeopleDirectoryDuplicatesUpgradeTask, RemoveRemoteAppsPluginUpgradeTask, RenameEhcachePropertiesUpgradeTask, SetAttachmentStorageSettingForClustersUpgradeTask, UserIndexingUpgradeTask, UserKeyReferenceUpgradeTask, UserMappingLowerUsernameSchemaUpgradeTask, UserMappingSchemaUpgradeTask, WelcomeMessageUpgradeTask, WikiToXhtmlMigrationUpgradeTask, XhtmlRoundTripMigrationUpgradeTask

public interface BackupSupport

Interface implemented by AbstractUpgradeTasks which provide information to the backup manager to manage backward and forward compatibility.

If you're unsure how to fill this information, please have a look at https://pug.jira.com/wiki/display/CONFDEV/How+to+add+to+or+change+the+Confluence+Database

Also, please list your upgrade task in https://pug.jira.com/wiki/display/CONFDEV/List+of+upgrade+tasks+in+Confluence

Method Summary

Modifier and Type	Method and Description
boolean	breaksBackwardCompatibility() Returns true if a new export can't be imported in an older instance.
boolean	runOnSpaceImport() Returns true if an older Space can't be imported in a new instance without running this task.

Method Detail

runOnSpaceImport

boolean runOnSpaceImport()

Returns true if an older Space can't be imported in a new instance without running this task. For example:

• A task updating macro names in the BodyContent table would be blocking.
• Tasks which updates data related to the space would be blocking.
• A task upgrading the user table wouldn't be blocking.
• Adding a mandatory column on space-related content breaks space import

Note that tasks don't run on space import yet, so we just reject the import in this case.

Since:

5.2

breaksBackwardCompatibility

boolean breaksBackwardCompatibility()

Returns true if a new export can't be imported in an older instance.

Breaking compatibility means a snapshot of the new version will not work at all with the previous version. For example:

• A destructive operation (Some data is replaced by another) breaks backwards compatibility
• Adding a optional column does NOT break backwards compatibility
• Data is copied to another column doesn't breaks backwards compatibility
• A build number incrementation doesn't breaks backwards compatibility

The best way to test is whether a newer export can be imported (with fully working features) in an older instance.

Since:

5.2