Class ExportDescriptor
java.lang.Object
com.atlassian.confluence.importexport.impl.ExportDescriptor
Describes an export, based on the exportDescriptor.properties.
- Since:
- 4.2
-
Nested Class Summary
-
Constructor Summary
ConstructorDescriptionConstruct a new ExportDescriptor, most likely with the intention of writing it out.ExportDescriptor
(Properties properties) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get the BuildNumber specified in the exportDescriptor properties file.Get the CreatedByBuildNumber specified in the exportDescriptor properties file.static ExportDescriptor
getExportDescriptor
(Unzipper unzipper) static ExportDescriptor
getExportDescriptor
(File exportZip) static Map<String,
PluginExportCompatibility> getPluginExportCompatibility
(Properties properties) getScope()
Source instance type - cloud or server.Version number of Confluence that was used to generate the export.boolean
boolean
void
saveToOutputStream
(OutputStream outputStream) void
setBackupAttachments
(boolean exportAttachments) void
setBuildNumber
(String buildNumber) void
setCreatedByBuildNumber
(String buildNumber) void
setDefaultUserGroup
(String defaultUsersGroup) void
setObjectsCount
(Long objectsCount) Writes the number of objects into content properties.void
setPluginExportCompatibility
(Map<String, PluginExportCompatibility> compatibility) void
setScope
(ExportScope scope) void
setSource
(ExportDescriptor.Source source) void
setSpaceKey
(String spaceKey) void
setSpaceKeys
(Collection<String> spaceKeys) void
setSupportEntitlementNumber
(String supportEntitlementNumber) void
setVersionNumber
(String versionNumber)
-
Constructor Details
-
ExportDescriptor
public ExportDescriptor(Properties properties) throws UnexpectedImportZipFileContents, ImportExportException -
ExportDescriptor
public ExportDescriptor()Construct a new ExportDescriptor, most likely with the intention of writing it out. When reading an ExportDescriptor usegetExportDescriptor(File)
.
-
-
Method Details
-
getExportDescriptor
public static ExportDescriptor getExportDescriptor(File exportZip) throws UnexpectedImportZipFileContents, ImportExportException -
getExportDescriptor
public static ExportDescriptor getExportDescriptor(Unzipper unzipper) throws UnexpectedImportZipFileContents, ImportExportException, IOException -
getProperties
-
getScope
-
setScope
-
getBuildNumber
Get the BuildNumber specified in the exportDescriptor properties file. If no descriptor is specified this returns null.- Returns:
- the specified BuildNumber or null
-
setBuildNumber
-
setPluginExportCompatibility
-
getPluginExportCompatibility
public static Map<String,PluginExportCompatibility> getPluginExportCompatibility(Properties properties) -
getSpaceKey
-
setSpaceKey
-
setSpaceKeys
-
isSpaceImport
public boolean isSpaceImport() -
isSiteImport
public boolean isSiteImport() -
setBackupAttachments
public void setBackupAttachments(boolean exportAttachments) -
getBackupAttachments
public boolean getBackupAttachments() -
saveToOutputStream
- Throws:
IOException
-
setCreatedByBuildNumber
-
getCreatedByBuildNumber
Get the CreatedByBuildNumber specified in the exportDescriptor properties file. If no descriptor is specified this returns null.- Returns:
- the specified BuildNumber or null
-
setDefaultUserGroup
-
getDefaultUserGroup
-
setVersionNumber
-
getVersionNumber
Version number of Confluence that was used to generate the export. -
setSource
-
setObjectsCount
Writes the number of objects into content properties. It is important for XML restore because it will be able to initialise the progress bar from the beginning (it will not need to read and count all the objects at the beginning).- Parameters:
objectsCount
- number of objects.- Since:
- 7.20.0
-
getObjectsCount
-
getSource
Source instance type - cloud or server. -
setSupportEntitlementNumber
-
getSupportEntitlementNumber
-