com.atlassian.confluence.importexport.impl
Class ExportDescriptor

java.lang.Object
  com.atlassian.confluence.importexport.impl.ExportDescriptor

public class ExportDescriptor
extends java.lang.Object

Describes an export, based on the exportDescriptor.properties.

Since:

4.2

Constructor Summary

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

Method Summary

BuildNumber	getBuildNumber() Get the BuildNumber specified in the exportDescriptor properties file.
BuildNumber	getCreatedByBuildNumber() Get the CreatedByBuildNumber specified in the exportDescriptor properties file.
java.lang.String	getDefaultUserGroup()
static ExportDescriptor	getExportDescriptor(java.io.File exportZip)
static java.util.Map<java.lang.String,PluginExportCompatibility>	getPluginExportCompatibility(java.util.Properties properties)
java.util.Properties	getProperties()
ExportScope	getScope()
java.lang.String	getSpaceKey()
boolean	isSpaceImport()
void	setBackupAttachments(boolean exportAttachments)
void	setBuildNumber(java.lang.String buildNumber)
void	setCreatedByBuildNumber(java.lang.String buildNumber)
void	setDefaultUserGroup(java.lang.String defaultUsersGroup)
void	setPluginExportCompatibility(java.util.Map<java.lang.String,PluginExportCompatibility> compatibility)
void	setScope(ExportScope scope)
void	setSpaceKey(java.lang.String spaceKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

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(java.io.File exportZip)
                                            throws UnexpectedImportZipFileContents,
                                                   ImportExportException

Throws:

UnexpectedImportZipFileContents

ImportExportException

getProperties

public java.util.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(java.lang.String buildNumber)

setPluginExportCompatibility

public void setPluginExportCompatibility(java.util.Map<java.lang.String,PluginExportCompatibility> compatibility)

getPluginExportCompatibility

public static java.util.Map<java.lang.String,PluginExportCompatibility> getPluginExportCompatibility(java.util.Properties properties)

getSpaceKey

public java.lang.String getSpaceKey()

setSpaceKey

public void setSpaceKey(java.lang.String spaceKey)

isSpaceImport

public boolean isSpaceImport()

setBackupAttachments

public void setBackupAttachments(boolean exportAttachments)

setCreatedByBuildNumber

public void setCreatedByBuildNumber(java.lang.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(java.lang.String defaultUsersGroup)

getDefaultUserGroup

public java.lang.String getDefaultUserGroup()