Package com.atlassian.confluence.importexport.impl

Class ExportDescriptor

java.lang.Object

com.atlassian.confluence.importexport.impl.ExportDescriptor

public class ExportDescriptor
extends Object

Describes an export, based on the exportDescriptor.properties.

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExportDescriptor.Source

Constructor Summary

Constructors

Constructor	Description
ExportDescriptor()	Construct a new ExportDescriptor, most likely with the intention of writing it out.
ExportDescriptor(Properties properties)

Method Summary

Modifier and Type	Method	Description
boolean	getBackupAttachments()
BuildNumber	getBuildNumber()	Get the BuildNumber specified in the exportDescriptor properties file.
BuildNumber	getCreatedByBuildNumber()	Get the CreatedByBuildNumber specified in the exportDescriptor properties file.
String	getDefaultUserGroup()
static ExportDescriptor	getExportDescriptor(Unzipper unzipper)
static ExportDescriptor	getExportDescriptor(File exportZip)
Long	getObjectsCount()
static Map<String,PluginExportCompatibility>	getPluginExportCompatibility(Properties properties)
Properties	getProperties()
ExportScope	getScope()
ExportDescriptor.Source	getSource()	Source instance type - cloud or server.
String	getSpaceKey()
String	getSupportEntitlementNumber()
String	getVersionNumber()	Version number of Confluence that was used to generate the export.
boolean	isSiteImport()
boolean	isSpaceImport()
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExportDescriptor

public ExportDescriptor(Properties properties)
                 throws UnexpectedImportZipFileContents,
                        ImportExportException

Throws:

UnexpectedImportZipFileContents

ImportExportException

ExportDescriptor

public ExportDescriptor()

Construct a new ExportDescriptor, most likely with the intention of writing it out. When reading an ExportDescriptor use getExportDescriptor(File).

Method Detail

getExportDescriptor

public static ExportDescriptor getExportDescriptor(File exportZip)
                                            throws UnexpectedImportZipFileContents,
                                                   ImportExportException

Throws:

UnexpectedImportZipFileContents

ImportExportException

getExportDescriptor

public static ExportDescriptor getExportDescriptor(Unzipper unzipper)
                                            throws UnexpectedImportZipFileContents,
                                                   ImportExportException,
                                                   IOException

Throws:

UnexpectedImportZipFileContents

ImportExportException

IOException

getProperties

public Properties getProperties()

getScope

public ExportScope getScope()
                     throws ExportScope.IllegalExportScopeException

Throws:

ExportScope.IllegalExportScopeException

setScope

public void setScope(ExportScope scope)

getBuildNumber

public BuildNumber 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

public void setBuildNumber(String buildNumber)

setPluginExportCompatibility

public void setPluginExportCompatibility(Map<String,PluginExportCompatibility> compatibility)

getPluginExportCompatibility

public static Map<String,PluginExportCompatibility> getPluginExportCompatibility(Properties properties)

getSpaceKey

public String getSpaceKey()

setSpaceKey

public void setSpaceKey(String spaceKey)

setSpaceKeys

public void setSpaceKeys(Collection<String> spaceKeys)

isSpaceImport

public boolean isSpaceImport()

isSiteImport

public boolean isSiteImport()

setBackupAttachments

public void setBackupAttachments(boolean exportAttachments)

getBackupAttachments

public boolean getBackupAttachments()

saveToOutputStream

public void saveToOutputStream(OutputStream outputStream)
                        throws IOException

Throws:

IOException

setCreatedByBuildNumber

public void setCreatedByBuildNumber(String buildNumber)

getCreatedByBuildNumber

public BuildNumber 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

public void setDefaultUserGroup(String defaultUsersGroup)

getDefaultUserGroup

public String getDefaultUserGroup()

setVersionNumber

public void setVersionNumber(String versionNumber)

getVersionNumber

public String getVersionNumber()

Version number of Confluence that was used to generate the export.

setSource

public void setSource(ExportDescriptor.Source source)

setObjectsCount

public void setObjectsCount(Long objectsCount)

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

public Long getObjectsCount()

getSource

public ExportDescriptor.Source getSource()

Source instance type - cloud or server.

setSupportEntitlementNumber

public void setSupportEntitlementNumber(String supportEntitlementNumber)

getSupportEntitlementNumber

public String getSupportEntitlementNumber()