@Component(value="cuba_EntityImportExport") public class EntityImportExport extends java.lang.Object implements EntityImportExportAPI
Modifier and Type | Class and Description |
---|---|
protected static class |
EntityImportExport.ReferenceInfo |
Modifier and Type | Field and Description |
---|---|
protected DataManager |
dataManager |
protected DynamicAttributesManagerAPI |
dynamicAttributesManagerAPI |
protected EntitySerializationAPI |
entitySerialization |
protected GlobalConfig |
globalConfig |
protected Metadata |
metadata |
protected Persistence |
persistence |
protected PersistenceSecurity |
persistenceSecurity |
protected ReferenceToEntitySupport |
referenceToEntitySupport |
protected StoreFactory |
storeFactory |
protected ViewRepository |
viewRepository |
NAME
Constructor and Description |
---|
EntityImportExport() |
Modifier and Type | Method and Description |
---|---|
protected View |
buildViewFromImportView(EntityImportView importView)
Method builds a regular
View from the EntityImportView . |
protected java.util.Collection<Entity> |
createNewCollection(MetaProperty metaProperty) |
java.lang.String |
exportEntitiesToJSON(java.util.Collection<? extends Entity> entities)
See documentation for
EntityImportExportService.exportEntitiesToJSON(Collection) |
java.lang.String |
exportEntitiesToJSON(java.util.Collection<? extends Entity> entities,
View view)
See documentation for
EntityImportExportService.exportEntitiesToJSON(Collection, View) |
byte[] |
exportEntitiesToZIP(java.util.Collection<? extends Entity> entities)
See documentation for
EntityImportExportService.exportEntitiesToZIP(Collection) |
byte[] |
exportEntitiesToZIP(java.util.Collection<? extends Entity> entities,
View view)
See documentation for
EntityImportExportService.exportEntitiesToZIP(Collection, View) |
protected Entity |
findReferenceEntity(Entity entity,
EntityImportViewProperty viewProperty,
CommitContext commitContext,
java.util.Set<Entity> loadedEntities) |
protected java.util.Collection |
getFilteredIds(Entity entity,
java.lang.String propertyName) |
protected java.util.Collection |
getFilteredIds(SecurityState securityState,
java.lang.String propertyName) |
protected Entity |
importEmbeddedAttribute(Entity srcEntity,
Entity dstEntity,
boolean createOp,
EntityImportViewProperty importViewProperty,
View regularView,
CommitContext commitContext,
java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList,
boolean optimisticLock) |
java.util.Collection<Entity> |
importEntities(java.util.Collection<? extends Entity> entities,
EntityImportView importView)
See documentation for
EntityImportExportService.importEntities(Collection, EntityImportView) |
java.util.Collection<Entity> |
importEntities(java.util.Collection<? extends Entity> entities,
EntityImportView importView,
boolean validate)
See documentation for
EntityImportExportService.importEntities(Collection, EntityImportView, boolean) |
java.util.Collection<Entity> |
importEntities(java.util.Collection<? extends Entity> entities,
EntityImportView importView,
boolean validate,
boolean optimisticLocking)
See documentation for
EntityImportExportService.importEntities(Collection, EntityImportView, boolean, boolean) |
java.util.Collection<Entity> |
importEntitiesFromJson(java.lang.String json,
EntityImportView view)
See documentation for
EntityImportExportService.importEntitiesFromJSON(String, EntityImportView) |
java.util.Collection<Entity> |
importEntitiesFromZIP(byte[] zipBytes,
EntityImportView view)
See documentation for
EntityImportExportService.importEntitiesFromZIP(byte[], EntityImportView) |
protected Entity |
importEntity(Entity srcEntity,
Entity dstEntity,
EntityImportView importView,
View regularView,
CommitContext commitContext,
java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList,
boolean optimisticLocking)
Method imports the entity.
|
protected void |
importManyToManyCollectionAttribute(Entity srcEntity,
Entity dstEntity,
SecurityState srcSecurityState,
EntityImportViewProperty viewProperty,
View regularView,
CommitContext commitContext,
java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList,
boolean optimisticLocking) |
protected void |
importOneToManyCollectionAttribute(Entity srcEntity,
Entity dstEntity,
SecurityState srcSecurityState,
EntityImportViewProperty viewProperty,
View regularView,
CommitContext commitContext,
java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList,
boolean optimisticLocking) |
protected void |
importReference(Entity srcEntity,
Entity dstEntity,
EntityImportViewProperty importViewProperty,
View regularView,
CommitContext commitContext,
java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList,
boolean optimisticLocking) |
protected org.apache.commons.compress.archivers.ArchiveEntry |
newStoredEntry(java.lang.String name,
byte[] data) |
protected void |
processReferenceInfo(EntityImportExport.ReferenceInfo referenceInfo,
CommitContext commitContext,
java.util.Set<Entity> 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 java.util.Collection<? extends Entity> |
reloadEntities(java.util.Collection<? extends Entity> entities,
View view) |
protected boolean |
useSecurityToken() |
@Inject protected EntitySerializationAPI entitySerialization
@Inject protected Persistence persistence
@Inject protected Metadata metadata
@Inject protected DataManager dataManager
@Inject protected DynamicAttributesManagerAPI dynamicAttributesManagerAPI
@Inject protected PersistenceSecurity persistenceSecurity
@Inject protected StoreFactory storeFactory
@Inject protected ViewRepository viewRepository
@Inject protected ReferenceToEntitySupport referenceToEntitySupport
@Inject protected GlobalConfig globalConfig
public byte[] exportEntitiesToZIP(java.util.Collection<? extends Entity> entities, View view)
EntityImportExportAPI
EntityImportExportService.exportEntitiesToZIP(Collection, View)
exportEntitiesToZIP
in interface EntityImportExportAPI
public byte[] exportEntitiesToZIP(java.util.Collection<? extends Entity> entities)
EntityImportExportAPI
EntityImportExportService.exportEntitiesToZIP(Collection)
exportEntitiesToZIP
in interface EntityImportExportAPI
public java.lang.String exportEntitiesToJSON(java.util.Collection<? extends Entity> entities, View view)
EntityImportExportAPI
EntityImportExportService.exportEntitiesToJSON(Collection, View)
exportEntitiesToJSON
in interface EntityImportExportAPI
public java.lang.String exportEntitiesToJSON(java.util.Collection<? extends Entity> entities)
EntityImportExportAPI
EntityImportExportService.exportEntitiesToJSON(Collection)
exportEntitiesToJSON
in interface EntityImportExportAPI
protected java.util.Collection<? extends Entity> reloadEntities(java.util.Collection<? extends Entity> entities, View view)
protected org.apache.commons.compress.archivers.ArchiveEntry newStoredEntry(java.lang.String name, byte[] data)
public java.util.Collection<Entity> importEntitiesFromJson(java.lang.String json, EntityImportView view)
EntityImportExportAPI
EntityImportExportService.importEntitiesFromJSON(String, EntityImportView)
importEntitiesFromJson
in interface EntityImportExportAPI
public java.util.Collection<Entity> importEntitiesFromZIP(byte[] zipBytes, EntityImportView view)
EntityImportExportAPI
EntityImportExportService.importEntitiesFromZIP(byte[], EntityImportView)
importEntitiesFromZIP
in interface EntityImportExportAPI
protected byte[] readBytesFromEntry(org.apache.commons.compress.archivers.zip.ZipArchiveInputStream archiveReader) throws java.io.IOException
java.io.IOException
public java.util.Collection<Entity> importEntities(java.util.Collection<? extends Entity> entities, EntityImportView importView)
EntityImportExportAPI
EntityImportExportService.importEntities(Collection, EntityImportView)
importEntities
in interface EntityImportExportAPI
public java.util.Collection<Entity> importEntities(java.util.Collection<? extends Entity> entities, EntityImportView importView, boolean validate)
EntityImportExportAPI
EntityImportExportService.importEntities(Collection, EntityImportView, boolean)
importEntities
in interface EntityImportExportAPI
public java.util.Collection<Entity> importEntities(java.util.Collection<? extends Entity> entities, EntityImportView importView, boolean validate, boolean optimisticLocking)
EntityImportExportAPI
EntityImportExportService.importEntities(Collection, EntityImportView, boolean, boolean)
importEntities
in interface EntityImportExportAPI
protected Entity importEntity(Entity srcEntity, @Nullable Entity dstEntity, EntityImportView importView, View regularView, CommitContext commitContext, java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList, boolean optimisticLocking)
srcEntity
- entity that came to the EntityImportExport
beandstEntity
- reloaded srcEntity or null if entity doesn't exist in the databaseimportView
- importView used for importing the entityregularView
- view that was used for loading dstEntitycommitContext
- entities that must be commited or deleted will be set to the commitContextreferenceInfoList
- list of referenceInfos for further processingoptimisticLocking
- whether the passed entity version should be validated before entity is persistedprotected void importReference(Entity srcEntity, Entity dstEntity, EntityImportViewProperty importViewProperty, View regularView, CommitContext commitContext, java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList, boolean optimisticLocking)
protected void importOneToManyCollectionAttribute(Entity srcEntity, Entity dstEntity, @Nullable SecurityState srcSecurityState, EntityImportViewProperty viewProperty, @Nullable View regularView, CommitContext commitContext, java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList, boolean optimisticLocking)
protected void importManyToManyCollectionAttribute(Entity srcEntity, Entity dstEntity, SecurityState srcSecurityState, EntityImportViewProperty viewProperty, View regularView, CommitContext commitContext, java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList, boolean optimisticLocking)
protected Entity importEmbeddedAttribute(Entity srcEntity, Entity dstEntity, boolean createOp, EntityImportViewProperty importViewProperty, View regularView, CommitContext commitContext, java.util.Collection<EntityImportExport.ReferenceInfo> referenceInfoList, boolean optimisticLock)
protected void processReferenceInfo(EntityImportExport.ReferenceInfo referenceInfo, CommitContext commitContext, java.util.Set<Entity> loadedEntities)
protected View buildViewFromImportView(EntityImportView importView)
View
from the EntityImportView
. The regular view will include all
properties defined in the import view.protected java.util.Collection getFilteredIds(Entity entity, java.lang.String propertyName)
protected java.util.Collection getFilteredIds(@Nullable SecurityState securityState, java.lang.String propertyName)
protected java.util.Collection<Entity> createNewCollection(MetaProperty metaProperty)
protected boolean useSecurityToken()
protected Entity findReferenceEntity(Entity entity, EntityImportViewProperty viewProperty, CommitContext commitContext, java.util.Set<Entity> loadedEntities)