Package io.jmix.dynmodel

Class DynamicModelManager

java.lang.Object

io.jmix.dynmodel.DynamicModelManager

@Component("dynmod_DynamicModelManager")
public class DynamicModelManager
extends Object

Calculates and applies dynamic model metadata and schema migrations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	DynamicModelManager.AttributeIdentityKind

Constructor Summary

Constructors

Constructor	Description
DynamicModelManager()

Method Summary

Modifier and Type	Method	Description
void	apply(DynamicModelDefinition modelDefinition)	Calculates and applies migrations for the provided dynamic model definition.
void	apply(List<DynamicModelMigration> migrations)	Applies the provided migration list.
void	apply(List<DynamicModelMigration> migrations, DynamicModelDefinition modelDefinition)	Applies the provided migration list and runs apply interceptors with the full model definition.
protected void	applyInternal(List<DynamicModelMigration> migrations, @Nullable DynamicModelDefinition modelDefinition)	Applies the provided migrations against a cloned working session and publishes the resulting generation atomically when metadata changes were produced.
Session	buildPreviewSession(DynamicModelDefinition modelDefinition)	Builds a detached metadata session reflecting the provided model definition without applying it.
void	checkApplyPermitted(List<DynamicModelMigration> migrations)	Checks that the current user may apply the provided migrations.
void	clear()	Removes all runtime dynamic model metadata, generated classes, dynamic messages, and managed schema objects.
protected void	clearInternal()	Clears all currently managed dynamic metadata and publishes a fresh session without dynamic additions.
protected @Nullable String	findInstanceNameAttribute(DynamicEntityDefinition entityDef)
protected Class<?>	getAttributeJavaType(DynamicAttributeDefinition attributeDef)
protected MetaProperty.Type	getAttributeType(DynamicAttributeDefinition attributeDef)
List<DynamicModelMigration>	getDataLosingMigrations(List<DynamicModelMigration> migrations)	Returns the migrations from the provided list that can lose stored data when applied: dropping an entity, an attribute or an enumeration, and changing an applied enumeration so that one of its value ids is removed.
List<DynamicModelMigration>	getMigrations(DynamicModelDefinition modelDefinition)	Calculates migrations required to make the current runtime model match the provided definition.
protected List<DynamicModelMigration>	getMigrationsInternal(DynamicModelDefinition modelDefinition)	Compares the requested model definition with the currently published dynamic model state and produces an ordered migration plan.
protected DynamicModelManager.AttributeIdentityKind	getStoredAttributeKind(MetaProperty property)
protected DynamicModelManager.AttributeIdentityKind	getStoredAttributeKind(DynamicAttributeDefinition attributeDef)
protected DynamicModelDefinitionException	incompatibleConstraint(String ownerEntityName, DynamicAttributeDefinition attributeDef, String annotation, String expectedType)
protected Map<String,DynamicUniqueConstraintDefinition>	indexUniqueConstraintsByName(List<DynamicUniqueConstraintDefinition> uniqueConstraints)
protected DynamicModelDefinitionException	invalidConstraintParameter(String ownerEntityName, DynamicAttributeDefinition attributeDef, DynamicAttributeConstraintDefinition constraint, String parameterName, String problem)
protected boolean	isDataLosingMigration(DynamicModelMigration migration)
protected boolean	isPropertyInstanceName(MetaProperty property)
protected DynamicAttributeDefinition	normalizeAttributeDefinition(DynamicAttributeDefinition attributeDef, String basePackage, boolean instanceName)
protected List<DynamicUniqueConstraintDefinition>	normalizeUniqueConstraints(DynamicEntityDefinition entityDef)
protected void	refreshEnumerationMetaProperties(String enumerationFqn, SessionImplementation session, GeneratedClassStore classStore)
protected void	registerPhysicalColumn(Map<String,String> logicalNamesByColumn, String columnName, String logicalName, String tableName)
protected boolean	removesEnumerationValues(DynamicModelMigration.UpsertEnumeration upsertEnumeration)
protected String	resolveEntityStore(DynamicEntityDefinition entityDefinition)
protected Map<String,String>	resolveModelEntityStores(List<DynamicEntityDefinition> entityDefinitions)
protected void	setInstanceNameAnnotation(MetaProperty property, boolean instanceName)
protected String	toLogicalPropertyName(MetaClass metaClass, String propertyPath)
protected void	validateAttributeConstraintDefinition(String ownerEntityName, DynamicAttributeDefinition attributeDef, DynamicAttributeConstraintDefinition constraint)
protected void	validateAttributeDefinition(String ownerEntityName, DynamicAttributeDefinition attributeDef, Set<String> modelEntityNames, Map<String,String> modelEntityStores)
protected void	validateAttributeIdentityUnchanged(String entityName, DynamicAttributeDefinition attributeDef, MetaProperty existingProperty)
protected void	validateAttributeValidationDefinition(String ownerEntityName, DynamicAttributeDefinition attributeDef)
protected void	validateCalculatedAttributeAcyclic(String entityName, String attributeName, Map<String,DynamicAttributeDefinition> attributesByName, LinkedHashSet<String> stack, Set<String> visited)
protected void	validateCalculatedAttributeDefinition(String ownerEntityName, DynamicAttributeDefinition attributeDef)
protected void	validateCalculatedAttributeGraph(DynamicEntityDefinition entityDef)
protected void	validateCollectionPropertyTarget(MetaClass ownerMetaClass, DynamicAttributeDefinition attributeDef, MetaClass childMetaClass)
protected void	validateCollectionTarget(String ownerEntityName, DynamicAttributeDefinition attributeDef, Set<String> modelEntityNames)
protected void	validateConstraintParameterTypes(String ownerEntityName, DynamicAttributeDefinition attributeDef, DynamicAttributeConstraintDefinition constraint)
protected void	validateEntityValidationDefinition(DynamicEntityDefinition entityDef)
protected void	validateLobAttribute(String ownerEntityName, DynamicAttributeDefinition attributeDef)
protected void	validateNewPhysicalColumn(Map<String,String> logicalNamesByColumn, String columnName, String logicalName, String tableName)
protected void	validateOwnerType(String ownerEntityName, DynamicAttributeDefinition attributeDef)
protected void	validateReferenceStore(String ownerEntityName, DynamicAttributeDefinition attributeDef, String targetEntityName, Map<String,String> modelEntityStores)
protected void	validateReferenceTarget(String ownerEntityName, DynamicAttributeDefinition attributeDef, Set<String> modelEntityNames, Map<String,String> modelEntityStores)
protected void	validateSearchableAttribute(String ownerEntityName, DynamicAttributeDefinition attributeDef)
protected void	validateStoredColumnConflicts(MetaClass metaClass, Collection<MetaProperty> newProperties)
protected void	validateUniqueConstraint(String entityName, Map<String,DynamicAttributeDefinition> attributesByName, DynamicUniqueConstraintDefinition uniqueConstraint)
protected void	validateUniqueConstraints(DynamicEntityDefinition entityDef, List<DynamicUniqueConstraintDefinition> uniqueConstraints)

Methods inherited from class java.lang.Object

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

Constructor Details

DynamicModelManager

public DynamicModelManager()

Method Details

apply

public void apply(DynamicModelDefinition modelDefinition)

Calculates and applies migrations for the provided dynamic model definition.

Parameters:

modelDefinition - dynamic model definition

getMigrations

public List<DynamicModelMigration> getMigrations(DynamicModelDefinition modelDefinition)

Calculates migrations required to make the current runtime model match the provided definition.

Parameters:

modelDefinition - target dynamic model definition

Returns:

ordered migration list

getMigrationsInternal

protected List<DynamicModelMigration> getMigrationsInternal(DynamicModelDefinition modelDefinition)

Compares the requested model definition with the currently published dynamic model state and produces an ordered migration plan.

This method validates declarative metadata as it walks the definition and emits only the minimal set of migration objects needed to converge the runtime model, including metadata, schema, and message updates.

Parameters:

modelDefinition - target dynamic model definition

Returns:

ordered migrations required to reach the target definition

getDataLosingMigrations

public List<DynamicModelMigration> getDataLosingMigrations(List<DynamicModelMigration> migrations)

Returns the migrations from the provided list that can lose stored data when applied: dropping an entity, an attribute or an enumeration, and changing an applied enumeration so that one of its value ids is removed. Stored values that refer to a removed enumeration value id can no longer be read.

A user who has only the DynmodSafeApplyAccessContext permission may apply only the migrations that this method does not return.

Parameters:

migrations - migrations calculated against the current runtime model

Returns:

migrations that can lose data, in the order of the provided list; empty if there are none

checkApplyPermitted

public void checkApplyPermitted(List<DynamicModelMigration> migrations)

Checks that the current user may apply the provided migrations. A user with the full apply permission may apply any migration; a user with only the permission to apply changes that cannot lose data may apply the migrations that getDataLosingMigrations(List) does not return.

Parameters:

migrations - migrations calculated against the current runtime model

Throws:

AccessDeniedException - if the user may not apply the migrations

isDataLosingMigration

protected boolean isDataLosingMigration(DynamicModelMigration migration)

removesEnumerationValues

protected boolean removesEnumerationValues(DynamicModelMigration.UpsertEnumeration upsertEnumeration)

apply

public void apply(List<DynamicModelMigration> migrations)

Applies the provided migration list.

Parameters:

migrations - migrations to apply

apply

public void apply(List<DynamicModelMigration> migrations,
 DynamicModelDefinition modelDefinition)

Applies the provided migration list and runs apply interceptors with the full model definition.

Parameters:

migrations - migrations to apply

modelDefinition - source dynamic model definition

applyInternal

protected void applyInternal(List<DynamicModelMigration> migrations,
 @Nullable DynamicModelDefinition modelDefinition)

Applies the provided migrations against a cloned working session and publishes the resulting generation atomically when metadata changes were produced.

Interceptors run against the working session before publication so dependent modules can validate and prepare generation-aligned runtime artifacts such as dynamic views and policies.

Parameters:

migrations - ordered migrations to apply

modelDefinition - full source definition when interceptor callbacks should run, or null for direct migration-only apply

buildPreviewSession

public Session buildPreviewSession(DynamicModelDefinition modelDefinition)

Builds a detached metadata session reflecting the provided model definition without applying it.

The build follows the same path as an apply — migrations against the published state, a cloned working session, metadata mutations — but performs no schema changes, no message updates, and no publication, and loads generated classes into a throwaway class loader instead of the global ClassManager. The running application observes nothing; the returned session and its classes are garbage-collected when no longer referenced.

Parameters:

modelDefinition - target dynamic model definition

Returns:

detached session containing the definition's metadata

validateLobAttribute

protected void validateLobAttribute(String ownerEntityName,
 DynamicAttributeDefinition attributeDef)

clear

public void clear()

Removes all runtime dynamic model metadata, generated classes, dynamic messages, and managed schema objects.

clearInternal

protected void clearInternal()

Clears all currently managed dynamic metadata and publishes a fresh session without dynamic additions. Runtime cleanup is deferred through retire actions so in-flight work can finish against the old generation.

resolveModelEntityStores

protected Map<String,String> resolveModelEntityStores(List<DynamicEntityDefinition> entityDefinitions)

resolveEntityStore

protected String resolveEntityStore(DynamicEntityDefinition entityDefinition)

findInstanceNameAttribute

protected @Nullable String findInstanceNameAttribute(DynamicEntityDefinition entityDef)

normalizeAttributeDefinition

protected DynamicAttributeDefinition normalizeAttributeDefinition(DynamicAttributeDefinition attributeDef,
 String basePackage,
 boolean instanceName)

normalizeUniqueConstraints

protected List<DynamicUniqueConstraintDefinition> normalizeUniqueConstraints(DynamicEntityDefinition entityDef)

validateAttributeDefinition

protected void validateAttributeDefinition(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 Set<String> modelEntityNames,
 Map<String,String> modelEntityStores)

validateSearchableAttribute

protected void validateSearchableAttribute(String ownerEntityName,
 DynamicAttributeDefinition attributeDef)

validateUniqueConstraints

protected void validateUniqueConstraints(DynamicEntityDefinition entityDef,
 List<DynamicUniqueConstraintDefinition> uniqueConstraints)

validateUniqueConstraint

protected void validateUniqueConstraint(String entityName,
 Map<String,DynamicAttributeDefinition> attributesByName,
 DynamicUniqueConstraintDefinition uniqueConstraint)

validateAttributeValidationDefinition

protected void validateAttributeValidationDefinition(String ownerEntityName,
 DynamicAttributeDefinition attributeDef)

validateAttributeConstraintDefinition

protected void validateAttributeConstraintDefinition(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 DynamicAttributeConstraintDefinition constraint)

validateConstraintParameterTypes

protected void validateConstraintParameterTypes(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 DynamicAttributeConstraintDefinition constraint)

invalidConstraintParameter

protected DynamicModelDefinitionException invalidConstraintParameter(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 DynamicAttributeConstraintDefinition constraint,
 String parameterName,
 String problem)

incompatibleConstraint

protected DynamicModelDefinitionException incompatibleConstraint(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 String annotation,
 String expectedType)

validateEntityValidationDefinition

protected void validateEntityValidationDefinition(DynamicEntityDefinition entityDef)

validateCalculatedAttributeDefinition

protected void validateCalculatedAttributeDefinition(String ownerEntityName,
 DynamicAttributeDefinition attributeDef)

validateCalculatedAttributeGraph

protected void validateCalculatedAttributeGraph(DynamicEntityDefinition entityDef)

validateCalculatedAttributeAcyclic

protected void validateCalculatedAttributeAcyclic(String entityName,
 String attributeName,
 Map<String,DynamicAttributeDefinition> attributesByName,
 LinkedHashSet<String> stack,
 Set<String> visited)

validateAttributeIdentityUnchanged

protected void validateAttributeIdentityUnchanged(String entityName,
 DynamicAttributeDefinition attributeDef,
 MetaProperty existingProperty)

getStoredAttributeKind

protected DynamicModelManager.AttributeIdentityKind getStoredAttributeKind(DynamicAttributeDefinition attributeDef)

getStoredAttributeKind

protected DynamicModelManager.AttributeIdentityKind getStoredAttributeKind(MetaProperty property)

getAttributeType

protected MetaProperty.Type getAttributeType(DynamicAttributeDefinition attributeDef)

getAttributeJavaType

protected Class<?> getAttributeJavaType(DynamicAttributeDefinition attributeDef)

validateReferenceTarget

protected void validateReferenceTarget(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 Set<String> modelEntityNames,
 Map<String,String> modelEntityStores)

validateReferenceStore

protected void validateReferenceStore(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 String targetEntityName,
 Map<String,String> modelEntityStores)

validateCollectionTarget

protected void validateCollectionTarget(String ownerEntityName,
 DynamicAttributeDefinition attributeDef,
 Set<String> modelEntityNames)

validateOwnerType

protected void validateOwnerType(String ownerEntityName,
 DynamicAttributeDefinition attributeDef)

validateCollectionPropertyTarget

protected void validateCollectionPropertyTarget(MetaClass ownerMetaClass,
 DynamicAttributeDefinition attributeDef,
 MetaClass childMetaClass)

refreshEnumerationMetaProperties

protected void refreshEnumerationMetaProperties(String enumerationFqn,
 SessionImplementation session,
 GeneratedClassStore classStore)

isPropertyInstanceName

protected boolean isPropertyInstanceName(MetaProperty property)

setInstanceNameAnnotation

protected void setInstanceNameAnnotation(MetaProperty property,
 boolean instanceName)

validateStoredColumnConflicts

protected void validateStoredColumnConflicts(MetaClass metaClass,
 Collection<MetaProperty> newProperties)

registerPhysicalColumn

protected void registerPhysicalColumn(Map<String,String> logicalNamesByColumn,
 String columnName,
 String logicalName,
 String tableName)

validateNewPhysicalColumn

protected void validateNewPhysicalColumn(Map<String,String> logicalNamesByColumn,
 String columnName,
 String logicalName,
 String tableName)

toLogicalPropertyName

protected String toLogicalPropertyName(MetaClass metaClass,
 String propertyPath)

indexUniqueConstraintsByName

protected Map<String,DynamicUniqueConstraintDefinition> indexUniqueConstraintsByName(List<DynamicUniqueConstraintDefinition> uniqueConstraints)