Package io.jmix.audit.snapshot.impl

Class EntitySnapshotManagerImpl

java.lang.Object

io.jmix.audit.snapshot.impl.EntitySnapshotManagerImpl

All Implemented Interfaces:

EntitySnapshotManager

@Component("audit_EntitySnapshotManager")
public class EntitySnapshotManagerImpl
extends Object
implements EntitySnapshotManager

Constructor Summary

Constructors

Constructor

Description

EntitySnapshotManagerImpl(ExtendedEntities extendedEntities, UnconstrainedDataManager unconstrainedDataManager, FetchPlans fetchPlans, MetadataTools metadataTools, Metadata metadata, ReferenceToEntitySupport referenceToEntitySupport, TimeSource timeSource, CurrentAuthentication currentAuthentication, EntitySerialization entitySerialization, FetchPlanSerialization fetchPlanSerialization, EntitySnapshotDataStore entitySnapshotDataStore)

Method Summary

Modifier and Type	Method	Description
EntitySnapshotModel	createSnapshot(Object entity, FetchPlan fetchPlan)	Create snapshot for Entity and store it to database
EntitySnapshotModel	createSnapshot(Object entity, FetchPlan fetchPlan, Date snapshotDate)	Create snapshot for Entity with specific date and store it to database
EntitySnapshotModel	createSnapshot(Object entity, FetchPlan fetchPlan, Date snapshotDate, String authorUsername)	Create snapshot for Entity with specific date and author and store it to database
EntitySnapshotModel	createTempSnapshot(Object entity, FetchPlan fetchPlan)	Creates non-persistent snapshot for entity.
EntitySnapshotModel	createTempSnapshot(Object entity, FetchPlan fetchPlan, Date snapshotDate)	Creates non-persistent snapshot for entity with a specific date.
EntitySnapshotModel	createTempSnapshot(Object entity, FetchPlan fetchPlan, Date snapshotDate, String authorUsername)	Creates non-persistent snapshot for entity with a specific date and author.
Object	extractEntity(EntitySnapshotModel snapshot)	Restore entity by snapshot
FetchPlan	extractFetchPlan(EntitySnapshotModel snapshot)	Restore fetch plan from snapshot
EntitySnapshotModel	getLastEntitySnapshot(MetaClass metaClass, Object referenceId)	Get the last snapshot for the given entity by id.
EntitySnapshotModel	getLastEntitySnapshot(Object entity)	Get the last snapshot for the given entity.
List<EntitySnapshotModel>	getSnapshots(MetaClass metaClass, Object id)	Load snapshots for entity
List<EntitySnapshotModel>	getSnapshots(Object entity)	Get snapshots for entity
void	migrateSnapshots(MetaClass metaClass, Object id, Map<Class,Class> classMapping)	Translate snapshots for archival classes

Methods inherited from class java.lang.Object

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

Constructor Details

EntitySnapshotManagerImpl

public EntitySnapshotManagerImpl(ExtendedEntities extendedEntities,
 UnconstrainedDataManager unconstrainedDataManager,
 FetchPlans fetchPlans,
 MetadataTools metadataTools,
 Metadata metadata,
 ReferenceToEntitySupport referenceToEntitySupport,
 TimeSource timeSource,
 CurrentAuthentication currentAuthentication,
 EntitySerialization entitySerialization,
 FetchPlanSerialization fetchPlanSerialization,
 EntitySnapshotDataStore entitySnapshotDataStore)

Method Details

getSnapshots

public List<EntitySnapshotModel> getSnapshots(MetaClass metaClass,
 Object id)

Description copied from interface: EntitySnapshotManager

Load snapshots for entity

Specified by:

getSnapshots in interface EntitySnapshotManager

Parameters:

metaClass - Entity metaclass

id - Entity Id

Returns:

Snapshot list sorted by snapshotDate desc

getSnapshots

public List<EntitySnapshotModel> getSnapshots(Object entity)

Description copied from interface: EntitySnapshotManager

Get snapshots for entity

Specified by:

getSnapshots in interface EntitySnapshotManager

Parameters:

entity - Entity object

Returns:

Snapshot list

migrateSnapshots

public void migrateSnapshots(MetaClass metaClass,
 Object id,
 Map<Class,Class> classMapping)

Description copied from interface: EntitySnapshotManager

Translate snapshots for archival classes

Specified by:

migrateSnapshots in interface EntitySnapshotManager

Parameters:

metaClass - Metaclass

id - Entity Id

classMapping - Map of [OldClass -> NewClass] for migration

createSnapshot

public EntitySnapshotModel createSnapshot(Object entity,
 FetchPlan fetchPlan)

Description copied from interface: EntitySnapshotManager

Create snapshot for Entity and store it to database

Specified by:

createSnapshot in interface EntitySnapshotManager

Parameters:

entity - Entity

fetchPlan - FetchPlan

Returns:

Snapshot

createSnapshot

public EntitySnapshotModel createSnapshot(Object entity,
 FetchPlan fetchPlan,
 Date snapshotDate)

Description copied from interface: EntitySnapshotManager

Create snapshot for Entity with specific date and store it to database

Specified by:

createSnapshot in interface EntitySnapshotManager

Parameters:

entity - Entity

fetchPlan - FetchPlan

snapshotDate - Date

Returns:

Snapshot

createSnapshot

public EntitySnapshotModel createSnapshot(Object entity,
 FetchPlan fetchPlan,
 Date snapshotDate,
 String authorUsername)

Description copied from interface: EntitySnapshotManager

Create snapshot for Entity with specific date and author and store it to database

Specified by:

createSnapshot in interface EntitySnapshotManager

Parameters:

entity - Entity

fetchPlan - FetchPlan

snapshotDate - Date

authorUsername - Author

Returns:

Snapshot

extractEntity

public Object extractEntity(EntitySnapshotModel snapshot)

Description copied from interface: EntitySnapshotManager

Restore entity by snapshot

Specified by:

extractEntity in interface EntitySnapshotManager

Parameters:

snapshot - Snapshot

Returns:

Entity instance

extractFetchPlan

public FetchPlan extractFetchPlan(EntitySnapshotModel snapshot)

Description copied from interface: EntitySnapshotManager

Restore fetch plan from snapshot

Specified by:

extractFetchPlan in interface EntitySnapshotManager

Parameters:

snapshot - Snapshot

Returns:

FetchPlan instance

getLastEntitySnapshot

@Nullable
public EntitySnapshotModel getLastEntitySnapshot(Object entity)

Description copied from interface: EntitySnapshotManager

Get the last snapshot for the given entity. This method always starts a new transaction. It can be used for entities with composite key if they have UUID.

Specified by:

getLastEntitySnapshot in interface EntitySnapshotManager

Parameters:

entity - entity

Returns:

snapshot or null if there is no snapshots in database for the given entity

getLastEntitySnapshot

@Nullable
public EntitySnapshotModel getLastEntitySnapshot(MetaClass metaClass,
 Object referenceId)

Description copied from interface: EntitySnapshotManager

Get the last snapshot for the given entity by id. This method always starts a new transaction.

Specified by:

getLastEntitySnapshot in interface EntitySnapshotManager

Parameters:

metaClass - entity meta class

referenceId - reference id for which snapshot refers

Returns:

snapshot or null if there is no snapshots in database for the given entity

createTempSnapshot

public EntitySnapshotModel createTempSnapshot(Object entity,
 FetchPlan fetchPlan)

Description copied from interface: EntitySnapshotManager

Creates non-persistent snapshot for entity. It can be used for entities with composite key if they have UUID.

Specified by:

createTempSnapshot in interface EntitySnapshotManager

Parameters:

entity - entity

fetchPlan - fetchPlan

Returns:

not persistence snapshot

createTempSnapshot

public EntitySnapshotModel createTempSnapshot(Object entity,
 FetchPlan fetchPlan,
 Date snapshotDate)

Description copied from interface: EntitySnapshotManager

Creates non-persistent snapshot for entity with a specific date. It can be used for entities with composite key if they have UUID.

Specified by:

createTempSnapshot in interface EntitySnapshotManager

Parameters:

entity - entity

fetchPlan - entity fetch plan

snapshotDate - date

Returns:

not persistence snapshot

createTempSnapshot

public EntitySnapshotModel createTempSnapshot(Object entity,
 FetchPlan fetchPlan,
 Date snapshotDate,
 String authorUsername)

Description copied from interface: EntitySnapshotManager

Creates non-persistent snapshot for entity with a specific date and author. It can be used for entities with composite key if they have UUID.

Specified by:

createTempSnapshot in interface EntitySnapshotManager

Parameters:

entity - entity

fetchPlan - entity fetch plan

snapshotDate - date

authorUsername - author

Returns:

not persistence snapshot