Package com.atlassian.confluence.impl.backuprestore.backup.exporters

Class ContentEntityDatabaseDataExporter

java.lang.Object

com.atlassian.confluence.impl.backuprestore.backup.exporters.ContentEntityDatabaseDataExporter

All Implemented Interfaces:

Exporter, Persister, Subscriber

public class ContentEntityDatabaseDataExporter
extends Object
implements Persister, Exporter, Subscriber

Responsible for exporting all content entitity objects. It starts with the current versions first and then continues with historical versions.

Since:

7.20.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTENT_IDS

Constructor Summary

Constructors

Constructor	Description
ContentEntityDatabaseDataExporter(DatabaseExporterHelper databaseExporterHelper, boolean keepCollectionsForContentProperties, ContentPropertyDataExporter contentPropertyDataExporter, Converter databaseDataConverter, CommonPersister commonPersister)	Creates an instance of content entity exporter.

Method Summary

Modifier and Type	Method	Description
ExportableEntityInfo	getEntityInfo()	Returns default entity info for persister.
ExportableEntityInfo	getEntityInfo(Class<?> exportedClass)	Returns default entity info for the particular class.
Collection<Class<?>>	getWatchingEntityClasses()	Return a collection of entity classes that subscriber will monitor the object export events.
void	onMonitoredObjectsExport(Class<?> exportedClass, Collection<Object> idList)	It is called when the collection of objects was exported.
void	persistObjects(Collection<Object> objectIds)	Retrieve a list of EntityObjectReadyForExport from object IDs and persist retrieved records for backup file NOTED: in order to deal with multiple underlining datatype from different DBs we will need to use AbstractDatabaseDataConverter.convertToLong(Object) to convert ID from Object to Long

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_IDS

public static final String CONTENT_IDS

See Also:

Constant Field Values

Constructor Detail

ContentEntityDatabaseDataExporter

public ContentEntityDatabaseDataExporter(DatabaseExporterHelper databaseExporterHelper,
                                         boolean keepCollectionsForContentProperties,
                                         ContentPropertyDataExporter contentPropertyDataExporter,
                                         Converter databaseDataConverter,
                                         CommonPersister commonPersister)

Creates an instance of content entity exporter.

Parameters:

databaseExporterHelper - just helper containing set of useful functions allowing to retrieve data from the DB.

keepCollectionsForContentProperties - set to true when it has to generate data in legacy format (with a collection of references to Content Properties).

contentPropertyDataExporter - reference to content property exporter (used for legacy format only)

Method Detail

getWatchingEntityClasses

public Collection<Class<?>> getWatchingEntityClasses()

Description copied from interface: Subscriber

Return a collection of entity classes that subscriber will monitor the object export events. This is called when DatabaseExporterHelper register subscribers for all exporters. See Use DatabaseExporterHelper.registerSubscriber(Subscriber)

Specified by:

getWatchingEntityClasses in interface Subscriber

getEntityInfo

public ExportableEntityInfo getEntityInfo()

Description copied from interface: Exporter

Returns default entity info for persister. Will fail if the persister has to work with multiple hibernate entitites.

Specified by:

getEntityInfo in interface Exporter

getEntityInfo

public ExportableEntityInfo getEntityInfo(Class<?> exportedClass)

Description copied from interface: Exporter

Returns default entity info for the particular class.

Specified by:

getEntityInfo in interface Exporter

persistObjects

public void persistObjects(Collection<Object> objectIds)
                    throws InterruptedException,
                           BackupRestoreException

Description copied from interface: Persister

Retrieve a list of EntityObjectReadyForExport from object IDs and persist retrieved records for backup file NOTED: in order to deal with multiple underlining datatype from different DBs we will need to use AbstractDatabaseDataConverter.convertToLong(Object) to convert ID from Object to Long

Specified by:

persistObjects in interface Persister

Throws:

InterruptedException

BackupRestoreException

onMonitoredObjectsExport

public void onMonitoredObjectsExport(Class<?> exportedClass,
                                     Collection<Object> idList)

Description copied from interface: Subscriber

It is called when the collection of objects was exported. This is called only for objects that this class is watching. See getWatchingEntityClasses()

Specified by:

onMonitoredObjectsExport in interface Subscriber

Parameters:

exportedClass - the exported class

idList - the list of ids of exported objects