Package io.jmix.core.impl.importexport

Class EntityImportExportImpl

java.lang.Object

io.jmix.core.impl.importexport.EntityImportExportImpl

All Implemented Interfaces:

EntityImportExport

@Component("core_EntityImportExport")
public class EntityImportExportImpl
extends Object
implements EntityImportExport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	EntityImportExportImpl.ReferenceInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessConstraintsRegistry	accessConstraintsRegistry
protected AccessManager	accessManager
protected org.springframework.context.ApplicationContext	applicationContext
protected CoreProperties	coreProperties
protected UnconstrainedDataManager	dataManager
protected EntitySerialization	entitySerialization
protected EntityStates	entityStates
protected EntityAttributeImportExtensionResolver	extensionResolver
protected FetchPlanRepository	fetchPlanRepository
protected FetchPlans	fetchPlans
protected Metadata	metadata
protected MetadataTools	metadataTools
protected ReferenceToEntitySupport	referenceToEntitySupport
protected Stores	stores
protected javax.validation.Validator	validator

Constructor Summary

Constructors

Constructor	Description
EntityImportExportImpl()

Method Summary

Modifier and Type	Method	Description
protected void	assertToken(Object entity, FetchPlan fetchPlan)
protected FetchPlanBuilder	constructFetchPlanFromImportPlan(EntityImportPlan importPlan)	Method constructs FetchPlanBuilder for a regular FetchPlan from the EntityImportPlan.
protected Collection<Object>	createNewCollection(MetaProperty metaProperty)
String	exportEntitiesToJSON(Collection<Object> entities)	Serializes a collection of entities to JSON using EntitySerialization.
String	exportEntitiesToJSON(Collection<Object> entities, FetchPlan fetchPlan)	Serializes a collection of entities to JSON using EntitySerialization.
byte[]	exportEntitiesToZIP(Collection<Object> entities)	Serializes a collection of entities to JSON using EntitySerialization and packs the JSON file into ZIP archive.
byte[]	exportEntitiesToZIP(Collection<Object> entities, FetchPlan fetchPlan)	Serializes a collection of entities to JSON using EntitySerialization and packs the JSON file into ZIP archive.
protected Object	findReferenceEntity(Object entity, EntityImportPlanProperty importPlanProperty, SaveContext saveContext, Set<Object> loadedEntities)
protected Collection<Object>	getFilteredIds(SecurityState securityState, String propertyName)
protected Object	importEmbeddedAttribute(Object srcEntity, Object dstEntity, boolean createOp, EntityImportPlanProperty importPlanProperty, FetchPlan fetchPlan, SaveContext saveContext, Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList, boolean optimisticLock)
Collection<Object>	importEntities(Collection<Object> entities, EntityImportPlan importPlan, boolean validate, boolean optimisticLocking, boolean additionComposition)
Collection	importEntities(Collection entities, EntityImportPlan importPlan)	See EntityImportExport.importEntities(Collection, EntityImportPlan, boolean).
Collection	importEntities(Collection entities, EntityImportPlan importPlan, boolean validate)	Persists entities according to the rules, described by the importPlan parameter.
Collection	importEntities(Collection entities, EntityImportPlan importPlan, boolean validate, boolean optimisticLocking)	Persists entities according to the rules, described by the importPlan parameter.
Collection	importEntitiesFromJson(String json, EntityImportPlan importPlan)	Deserializes the JSON and persists deserialized entities according to the rules, described by the importPlan parameter.
Collection<Object>	importEntitiesFromZIP(byte[] zipBytes, EntityImportPlan importPlan)	Reads a zip archive that contains a JSON file, deserializes the JSON and persists deserialized entities according to the rules, described by the importPlan parameter.
protected Object	importEntity(Object srcEntity, Object dstEntity, EntityImportPlan importPlan, FetchPlan fetchPlan, SaveContext saveContext, Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList, boolean optimisticLocking, boolean additionComposition)	Method imports the entity.
void	importEntityIntoSaveContext(SaveContext saveContext, Object srcEntity, EntityImportPlan importPlan, boolean validate)
void	importEntityIntoSaveContext(SaveContext saveContext, Object srcEntity, EntityImportPlan importPlan, boolean validate, boolean optimisticLocking)
void	importEntityIntoSaveContext(SaveContext saveContext, Object srcEntity, EntityImportPlan importPlan, boolean validate, boolean optimisticLocking, boolean additionComposition)
protected void	importManyToManyCollectionAttribute(Object srcEntity, Object dstEntity, EntityImportPlanProperty importPlanProperty, FetchPlan fetchPlan, SaveContext saveContext, Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList, boolean optimisticLocking)
protected void	importOneToManyCollectionAttribute(Object srcEntity, Object dstEntity, EntityImportPlanProperty importPlanProperty, FetchPlan fetchPlan, SaveContext saveContext, Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList, boolean optimisticLocking, boolean additionalComposition)
protected void	importReference(Object srcEntity, Object dstEntity, EntityImportPlanProperty importPlanProperty, FetchPlan fetchPlan, SaveContext saveContext, Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList, boolean optimisticLocking)
protected org.apache.commons.compress.archivers.ArchiveEntry	newStoredEntry(String name, byte[] data)
protected void	processReferenceInfo(EntityImportExportImpl.ReferenceInfo referenceInfo, SaveContext saveContext, Set<Object> loadedEntities)	Method finds and set a reference value to the entity or throws EntityImportException if ERROR_ON_MISSING policy is violated
protected byte[]	readBytesFromEntry(org.apache.commons.compress.archivers.zip.ZipArchiveInputStream archiveReader)
protected Collection	reloadEntities(Collection<Object> entities, FetchPlan fetchPlan)
protected void	validateEntities(Collection<Object> entitiesToValidate)

Methods inherited from class java.lang.Object

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

Field Details

entitySerialization

@Autowired
protected EntitySerialization entitySerialization

metadata

@Autowired
protected Metadata metadata

dataManager

@Autowired
protected UnconstrainedDataManager dataManager

metadataTools

@Autowired
protected MetadataTools metadataTools

fetchPlans

@Autowired
protected FetchPlans fetchPlans

validator

@Autowired
protected javax.validation.Validator validator

stores

@Autowired
protected Stores stores

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

referenceToEntitySupport

@Autowired
protected ReferenceToEntitySupport referenceToEntitySupport

entityStates

@Autowired
protected EntityStates entityStates

accessConstraintsRegistry

@Autowired
protected AccessConstraintsRegistry accessConstraintsRegistry

accessManager

@Autowired
protected AccessManager accessManager

coreProperties

@Autowired
protected CoreProperties coreProperties

extensionResolver

@Autowired
protected EntityAttributeImportExtensionResolver extensionResolver

Constructor Details

EntityImportExportImpl

public EntityImportExportImpl()

Method Details

exportEntitiesToZIP

public byte[] exportEntitiesToZIP(Collection<Object> entities,
 FetchPlan fetchPlan)

Description copied from interface: EntityImportExport

Serializes a collection of entities to JSON using EntitySerialization and packs the JSON file into ZIP archive. Before the serialization entities will be reloaded with the fetch plan passed as method parameter.

Serialization is described in the EntitySerialization.toJson(Collection) method documentation

Specified by:

exportEntitiesToZIP in interface EntityImportExport

Parameters:

entities - a collection of entities to export

fetchPlan - before serialization to JSON entities will be reloaded with this fetch plan

Returns:

a byte array of zipped JSON file

exportEntitiesToZIP

public byte[] exportEntitiesToZIP(Collection<Object> entities)

Description copied from interface: EntityImportExport

Serializes a collection of entities to JSON using EntitySerialization and packs the JSON file into ZIP archive.

Serialization is described in the EntitySerialization.toJson(Collection) method documentation

Specified by:

exportEntitiesToZIP in interface EntityImportExport

Parameters:

entities - a collection of entities to export

Returns:

a byte array of zipped JSON file

exportEntitiesToJSON

public String exportEntitiesToJSON(Collection<Object> entities,
 FetchPlan fetchPlan)

Description copied from interface: EntityImportExport

Serializes a collection of entities to JSON using EntitySerialization. Before the serialization entities will be reloaded with the fetch plan passed as method parameter.

Serialization is described in the EntitySerialization.toJson(Collection) method documentation

Specified by:

exportEntitiesToJSON in interface EntityImportExport

Parameters:

entities - a collection of entities to export

fetchPlan - before serialization to JSON entities will be reloaded with this fetch plan

Returns:

a JSON string

exportEntitiesToJSON

public String exportEntitiesToJSON(Collection<Object> entities)

Description copied from interface: EntityImportExport

Serializes a collection of entities to JSON using EntitySerialization.

Serialization is described in the EntitySerialization.toJson(Collection) method documentation

Specified by:

exportEntitiesToJSON in interface EntityImportExport

Parameters:

entities - a collection of entities to export

Returns:

a JSON string

reloadEntities

protected Collection reloadEntities(Collection<Object> entities,
 FetchPlan fetchPlan)

newStoredEntry

protected org.apache.commons.compress.archivers.ArchiveEntry newStoredEntry(String name,
 byte[] data)

importEntitiesFromJson

public Collection importEntitiesFromJson(String json,
 EntityImportPlan importPlan)

Description copied from interface: EntityImportExport

Deserializes the JSON and persists deserialized entities according to the rules, described by the importPlan parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the importPlan will be updated.

Specified by:

importEntitiesFromJson in interface EntityImportExport

Parameters:

json - JSON file containing entities

importPlan - EntityImportPlan with the rules that describes how entities should be persisted.

Returns:

a collection of entities that have been imported

See Also:

• EntityImportPlan

importEntitiesFromZIP

public Collection<Object> importEntitiesFromZIP(byte[] zipBytes,
 EntityImportPlan importPlan)

Description copied from interface: EntityImportExport

Reads a zip archive that contains a JSON file, deserializes the JSON and persists deserialized entities according to the rules, described by the importPlan parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the importPlan will be updated.

Specified by:

importEntitiesFromZIP in interface EntityImportExport

Parameters:

zipBytes - byte array of ZIP archive with JSON file

importPlan - EntityImportPlan with the rules that describes how entities should be persisted.

Returns:

a collection of entities that have been imported

See Also:

• EntityImportPlan

readBytesFromEntry

protected byte[] readBytesFromEntry(org.apache.commons.compress.archivers.zip.ZipArchiveInputStream archiveReader)
                             throws IOException

Throws:

IOException

importEntities

public Collection importEntities(Collection entities,
 EntityImportPlan importPlan)

Description copied from interface: EntityImportExport

See EntityImportExport.importEntities(Collection, EntityImportPlan, boolean). The current method doesn't perform bean validation

Specified by:

importEntities in interface EntityImportExport

importEntities

public Collection importEntities(Collection entities,
 EntityImportPlan importPlan,
 boolean validate)

Description copied from interface: EntityImportExport

Persists entities according to the rules, described by the importPlan parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the importPlan will be updated.

If the import plan contains a property for composition attribute then all composition collection members that are absent in the passed entity will be removed.

Specified by:

importEntities in interface EntityImportExport

importPlan - EntityImportPlan with the rules that describes how entities should be persisted.

validate - whether the passed entities should be validated by the bean validation mechanism before entities are persisted

Returns:

a collection of entities that have been imported

importEntities

public Collection importEntities(Collection entities,
 EntityImportPlan importPlan,
 boolean validate,
 boolean optimisticLocking)

Description copied from interface: EntityImportExport

Persists entities according to the rules, described by the importPlan parameter. If the entity is not present in the database, it will be saved. Otherwise the fields of the existing entity that are in the importPlan will be updated.

If the import plan contains a property for composition attribute then all composition collection members that are absent in the passed entity will be removed.

Specified by:

importEntities in interface EntityImportExport

importPlan - EntityImportPlan with the rules that describes how entities should be persisted.

validate - whether the passed entities should be validated by the bean validation mechanism before entities are persisted

optimisticLocking - whether the passed entities versions should be validated before entities are persisted

Returns:

a collection of entities that have been imported

importEntities

public Collection<Object> importEntities(Collection<Object> entities,
 EntityImportPlan importPlan,
 boolean validate,
 boolean optimisticLocking,
 boolean additionComposition)

Specified by:

importEntities in interface EntityImportExport

importEntityIntoSaveContext

public void importEntityIntoSaveContext(SaveContext saveContext,
 Object srcEntity,
 EntityImportPlan importPlan,
 boolean validate)

Specified by:

importEntityIntoSaveContext in interface EntityImportExport

importEntityIntoSaveContext

public void importEntityIntoSaveContext(SaveContext saveContext,
 Object srcEntity,
 EntityImportPlan importPlan,
 boolean validate,
 boolean optimisticLocking)

Specified by:

importEntityIntoSaveContext in interface EntityImportExport

importEntityIntoSaveContext

public void importEntityIntoSaveContext(SaveContext saveContext,
 Object srcEntity,
 EntityImportPlan importPlan,
 boolean validate,
 boolean optimisticLocking,
 boolean additionComposition)

Specified by:

importEntityIntoSaveContext in interface EntityImportExport

validateEntities

protected void validateEntities(Collection<Object> entitiesToValidate)

importEntity

protected Object importEntity(Object srcEntity,
 @Nullable
 Object dstEntity,
 EntityImportPlan importPlan,
 FetchPlan fetchPlan,
 SaveContext saveContext,
 Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList,
 boolean optimisticLocking,
 boolean additionComposition)

Method imports the entity.

Parameters:

srcEntity - entity that came to the EntityImportExport bean

dstEntity - reloaded srcEntity or null if entity doesn't exist in the database

importPlan - importPlan used for importing the entity

fetchPlan - fetchPlan that was used for loading dstEntity

saveContext - entities that must be commited or deleted will be set to the saveContext

referenceInfoList - list of referenceInfos for further processing

optimisticLocking - whether the passed entity version should be validated before entity is persisted

Returns:

dstEntity that has fields values from the srcEntity

importReference

protected void importReference(Object srcEntity,
 Object dstEntity,
 EntityImportPlanProperty importPlanProperty,
 @Nullable
 FetchPlan fetchPlan,
 SaveContext saveContext,
 Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList,
 boolean optimisticLocking)

importOneToManyCollectionAttribute

protected void importOneToManyCollectionAttribute(Object srcEntity,
 Object dstEntity,
 EntityImportPlanProperty importPlanProperty,
 @Nullable
 FetchPlan fetchPlan,
 SaveContext saveContext,
 Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList,
 boolean optimisticLocking,
 boolean additionalComposition)

importManyToManyCollectionAttribute

protected void importManyToManyCollectionAttribute(Object srcEntity,
 Object dstEntity,
 EntityImportPlanProperty importPlanProperty,
 @Nullable
 FetchPlan fetchPlan,
 SaveContext saveContext,
 Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList,
 boolean optimisticLocking)

importEmbeddedAttribute

@Nullable
protected Object importEmbeddedAttribute(Object srcEntity,
 Object dstEntity,
 boolean createOp,
 EntityImportPlanProperty importPlanProperty,
 FetchPlan fetchPlan,
 SaveContext saveContext,
 Collection<EntityImportExportImpl.ReferenceInfo> referenceInfoList,
 boolean optimisticLock)

processReferenceInfo

protected void processReferenceInfo(EntityImportExportImpl.ReferenceInfo referenceInfo,
 SaveContext saveContext,
 Set<Object> loadedEntities)

Method finds and set a reference value to the entity or throws EntityImportException if ERROR_ON_MISSING policy is violated

constructFetchPlanFromImportPlan

protected FetchPlanBuilder constructFetchPlanFromImportPlan(EntityImportPlan importPlan)

Method constructs FetchPlanBuilder for a regular FetchPlan from the EntityImportPlan. The regular fetchPlan will include all properties defined in the import plan.

getFilteredIds

protected Collection<Object> getFilteredIds(@Nullable
 SecurityState securityState,
 String propertyName)

createNewCollection

protected Collection<Object> createNewCollection(MetaProperty metaProperty)

findReferenceEntity

@Nullable
protected Object findReferenceEntity(Object entity,
 EntityImportPlanProperty importPlanProperty,
 SaveContext saveContext,
 Set<Object> loadedEntities)

assertToken

protected void assertToken(Object entity,
 FetchPlan fetchPlan)