com.atlassian.confluence.importexport.impl

Class ExportUtils

java.lang.Object

com.atlassian.confluence.importexport.impl.ExportUtils

public class ExportUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_BACKUP_ATTACHMENTS
static String	PROP_BUILD_NUMBER build number of the earliest confluence version that this export can be imported by
static String	PROP_CREATED_BY_BUILD_NUMBER build number of the version of confluence that was used to generate export
static String	PROP_DEFAULT_USERS_GROUP Default users group for this instance, used to remap group permissions on import.
static String	PROP_EXPORT_TYPE
static String	PROP_EXPORTED_SPACEKEY Indicates a specific space key which has been exported.
static String	PROP_PLUGIN_CREATED_BY_VERSION Plugin version used to export (Mostly for ActiveObjects data)
static String	PROP_PLUGIN_EARLIEST_VERSION Earliest plugin version compatible with export
static String	PROP_PLUGINS_EXPORTING_DATA
static String	PROP_TIMEZONE_ID

Constructor Summary

Constructors

Constructor and Description
ExportUtils()

Method Summary

Modifier and Type	Method and Description
static String	getTitleAsFilename(ContentEntityObject ceo) Utility method to return a version of the content entity's title that's suitable to be used as a filename in an export.
static String	getTitleAsFilename(SearchResult searchResult)
protected static String	getTitleAsFilename(String title, String id)
static boolean	isSafeTitleForFilesystem(String title) Ensure the title is safe to be written to the file system.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_BUILD_NUMBER

public static final String PROP_BUILD_NUMBER

build number of the earliest confluence version that this export can be imported by

See Also:

Constant Field Values

PROP_TIMEZONE_ID

public static final String PROP_TIMEZONE_ID

See Also:

Constant Field Values

PROP_EXPORT_TYPE

public static final String PROP_EXPORT_TYPE

See Also:

Constant Field Values

PROP_BACKUP_ATTACHMENTS

public static final String PROP_BACKUP_ATTACHMENTS

See Also:

Constant Field Values

PROP_EXPORTED_SPACEKEY

public static final String PROP_EXPORTED_SPACEKEY

Indicates a specific space key which has been exported.

See Also:

Constant Field Values

PROP_CREATED_BY_BUILD_NUMBER

public static final String PROP_CREATED_BY_BUILD_NUMBER

build number of the version of confluence that was used to generate export

See Also:

Constant Field Values

PROP_DEFAULT_USERS_GROUP

public static final String PROP_DEFAULT_USERS_GROUP

Default users group for this instance, used to remap group permissions on import. See {#link com.atlassian.studio.confluence.importexport.PermissionsImportPreProcessor}

See Also:

Constant Field Values

PROP_PLUGIN_CREATED_BY_VERSION

public static final String PROP_PLUGIN_CREATED_BY_VERSION

Plugin version used to export (Mostly for ActiveObjects data)

See Also:

Constant Field Values

PROP_PLUGIN_EARLIEST_VERSION

public static final String PROP_PLUGIN_EARLIEST_VERSION

Earliest plugin version compatible with export

See Also:

Constant Field Values

PROP_PLUGINS_EXPORTING_DATA

public static final String PROP_PLUGINS_EXPORTING_DATA

See Also:

Constant Field Values

Constructor Detail

ExportUtils

public ExportUtils()

Method Detail

getTitleAsFilename

public static String getTitleAsFilename(ContentEntityObject ceo)

Utility method to return a version of the content entity's title that's suitable to be used as a filename in an export. Falls back to using the content entity's ID if the title contains unsuitable characters.

This method is used to centralise the code since symmetry is required in the creation of the files during export and the creation of the links to these files in the exported content.

Parameters:

ceo - the ContentEntityObject to retrieve a suitable filename for.

Returns:

a suitable filename for the object.

getTitleAsFilename

public static String getTitleAsFilename(SearchResult searchResult)

getTitleAsFilename

protected static String getTitleAsFilename(String title,
                                           String id)

isSafeTitleForFilesystem

public static boolean isSafeTitleForFilesystem(String title)

Ensure the title is safe to be written to the file system. See CONF-10741.

Parameters:

title - The title to check

Returns:

True if the title is safe for the filesystem, false otherwise