com.atlassian.confluence.importexport.xmlimport

Class HibernateImportProcessorContext

java.lang.Object

com.atlassian.confluence.importexport.xmlimport.BaseImportProcessorContext

com.atlassian.confluence.importexport.xmlimport.HibernateImportProcessorContext

All Implemented Interfaces:

ImportProcessorSummary, ImportProcessorContext

public class HibernateImportProcessorContext
extends BaseImportProcessorContext

Context that records the current state of an import, and provides helper methods that are dependent on that state. The context is responsible for keeping track of which objects have been imported, any ID re-mappings that have occurred during the import, any operations that have been deferred because some dependent object is not present.

Constructor Summary

Constructors

Constructor and Description
HibernateImportProcessorContext(org.hibernate.engine.spi.SessionImplementor session, org.hibernate.engine.spi.SessionFactoryImplementor sessionFactory, ProgressMeter meter, boolean preserveIds, ImportedObjectPreProcessor preProcessor, Properties exportDescriptor)

Method Summary

Modifier and Type	Method and Description
void	addUnsatisfiedObjectDependencies(Set<ImportEntityHandle> unsatisfiedObjectDependencies, ImportedObject importedObject) Defer the saving of an object because it has referential dependencies on some objects that have not yet been imported, but that can not be temporarily left null.
void	deferOperations(Map<ImportEntityHandle,Set<Operation>> operations) Deprecated. since 5.2 Use deferOperations(PrimitiveId, Map)
void	deferOperations(PrimitiveId idProperty, Map<ImportEntityHandle,Set<Operation>> operations) Defer a set of operations until the objects they require have been imported.
<T> Object	generateNewIdFor(Class<T> clazz, T object)
protected <T> Serializable	generateNewIdFor(Class<T> clazz, T object, Serializable idValue)
org.hibernate.persister.entity.EntityPersister	getEntityPersister(Class classToPersist) Get the Hibernate class persister for a particular class.
Properties	getExportDescriptor()
protected Serializable	getIdMapping(Object obj, Serializable idValue, Class clazz)
org.hibernate.engine.spi.SessionImplementor	getSession() Gets the current Hibernate session.
boolean	isPropertyNullable(Class classToPersist, String propertyName)
void	objectImported(ImportEntityHandle handle) Record that a particular object has been successfully persisted.
void	reportIncompleteDefferredOperations() Log any deferred operations that are still pending.
Object	resolveHandle(ImportEntityHandle handle)
void	saveObject(Object object) Save a particular object to the Hibernate session.
void	saveObject(Serializable id, Class classToPersist, Object objectToPersist)

Methods inherited from class com.atlassian.confluence.importexport.xmlimport.BaseImportProcessorContext

addExplicitIdMapping, getContextVariable, getIdMappingFor, getImportedObjectHandlesOfType, getImportedObjectsOfType, getPendingDeferredImportedObjects, getPersistedMappedHandles, getPersistedUnmappedHandles, getPreProcessor, getUnfixedIdFor, hasPendingDeferredObject, isObjectAlreadyImported, isPreserveIds, lookupObjectByUnfixedHandle, nextPendingDeferredObject, polyMorphicLookupByUnfixedId, setContextVariable

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateImportProcessorContext

public HibernateImportProcessorContext(org.hibernate.engine.spi.SessionImplementor session,
                                       org.hibernate.engine.spi.SessionFactoryImplementor sessionFactory,
                                       ProgressMeter meter,
                                       boolean preserveIds,
                                       ImportedObjectPreProcessor preProcessor,
                                       Properties exportDescriptor)

Method Detail

objectImported

public void objectImported(ImportEntityHandle handle)
                    throws Exception

Record that a particular object has been successfully persisted. This will trigger any deferred operations that were waiting on that object to exist.

Specified by:

objectImported in interface ImportProcessorContext

Overrides:

objectImported in class BaseImportProcessorContext

Parameters:

handle - the handle of the persisted object, before any ID mapping occurred

Throws:

Exception - if some error occurred running the deferred operations

getEntityPersister

public org.hibernate.persister.entity.EntityPersister getEntityPersister(Class classToPersist)

Get the Hibernate class persister for a particular class.

saveObject

public void saveObject(Object object)
                throws ImportExportException

Save a particular object to the Hibernate session. IDs will be assigned to the object using Hibernate's standard ID generation. Should only be used if you are creating new objects during an import (i.e. migrating from an old data representation to some new one where IDs can not be preserved).

Throws:

ImportExportException

isPropertyNullable

public boolean isPropertyNullable(Class classToPersist,
                                  String propertyName)

resolveHandle

public Object resolveHandle(ImportEntityHandle handle)
                     throws ImportExportException

Specified by:

resolveHandle in class BaseImportProcessorContext

Throws:

ImportExportException

getSession

public org.hibernate.engine.spi.SessionImplementor getSession()

Gets the current Hibernate session. Returns a SessionImplementor because our import code needs access to the Hibernate internals in order to work. This is a bug, not a feature.

deferOperations

public void deferOperations(PrimitiveId idProperty,
                            Map<ImportEntityHandle,Set<Operation>> operations)

Defer a set of operations until the objects they require have been imported.

Specified by:

deferOperations in interface ImportProcessorContext

Overrides:

deferOperations in class BaseImportProcessorContext

Parameters:

idProperty - ID of the object on which the operations will be performed.

operations - a map between the handle of the object that is being waited on, and the set of operations that should be executed once that object is imported.

deferOperations

@Deprecated
public void deferOperations(Map<ImportEntityHandle,Set<Operation>> operations)

Deprecated. since 5.2 Use deferOperations(PrimitiveId, Map)

Defer a set of operations until the objects they require have been imported.

Parameters:

operations - a map between the handle of the object that is being waited on, and the set of operations that should be executed once that object is imported.

addUnsatisfiedObjectDependencies

public void addUnsatisfiedObjectDependencies(Set<ImportEntityHandle> unsatisfiedObjectDependencies,
                                             ImportedObject importedObject)

Defer the saving of an object because it has referential dependencies on some objects that have not yet been imported, but that can not be temporarily left null. Once the objects being depended on have been imported, the deferred object will be available from BaseImportProcessorContext.nextPendingDeferredObject()

Specified by:

addUnsatisfiedObjectDependencies in interface ImportProcessorContext

Overrides:

addUnsatisfiedObjectDependencies in class BaseImportProcessorContext

Parameters:

unsatisfiedObjectDependencies -

importedObject -

See Also:

BaseImportProcessorContext.nextPendingDeferredObject(), BaseImportProcessorContext.hasPendingDeferredObject()

saveObject

public void saveObject(Serializable id,
                       Class classToPersist,
                       Object objectToPersist)
                throws ImportExportException

Throws:

ImportExportException

reportIncompleteDefferredOperations

public void reportIncompleteDefferredOperations()
                                         throws Exception

Log any deferred operations that are still pending. Usually done at the end of an import in case something went wrong with the dependency mechanism (or the backup was corrupt)

Throws:

Exception - there was some problem reporting the deferred operations (should not happen)

getIdMapping

protected Serializable getIdMapping(Object obj,
                                    Serializable idValue,
                                    Class clazz)
                             throws ImportExportException

Overrides:

getIdMapping in class BaseImportProcessorContext

Throws:

ImportExportException

generateNewIdFor

protected <T> Serializable generateNewIdFor(Class<T> clazz,
                                            T object,
                                            Serializable idValue)
                                     throws ImportExportException

Specified by:

generateNewIdFor in class BaseImportProcessorContext

Throws:

ImportExportException

generateNewIdFor

public <T> Object generateNewIdFor(Class<T> clazz,
                                   T object)
                            throws SQLException

Throws:

SQLException

getExportDescriptor

public Properties getExportDescriptor()